Technical Guide

1. Introduction #

BluePrint Business Intelligence (BluePrintBI or BPBI) is a business process management solution that enables businesses to create and maintain business processes, with supporting documents, in a central repository.
The BluePrintBI solution consists of various modules and access points. It may require participants from different areas to prepare and install a new and/or upgrade version of the system. The solution requires:

  1. Desktop installation with installed MS Office products (All client desktops in PROD, recommended to use additional VM/machine for TEST which is separate from PROD environments)
    • Note that BluePrintBI solution consists of various modules which have to be independently installed according to requirements. These installs are BluePrintBI, SourceFusion, QueryFusion and VisualFusion.
    • BluePrintBI and SourceFusion are installed on the client machine (separate installers)
    • QueryFusion and VisualFusion is installed on the server (QueryFusion and VisualFusion are installed as applications and shared over the network)
  2. SQL Server with the installed databases and user access/permissions to those databases on a network Server (TEST and PROD)
    • Note that BluePrintBI has a database separate from the import module called SourceFusion. The solution requires a minimum of two databases to be hosted on the SQL Server (one for BPBI and one for SF)
  3. Web Server with the installed files and IIS configuration (TEST and PROD)
    1. BluePrintBI_Online website
    2. VisualFusion
    3. QueryFusion

This document will clarify the requirements of each of the above environments that are needed to use this version of BluePrintBI and SourceFusion. Please note that these requirements may change with new versions of the application(s). (Please see “Appendix B: Architecture Layout”).


The document firstly gives a high-level overview of the process to implement a new/upgrade version of the BluePrintBI solution. It will then outline all the requirements for the various environments (servers and desktop) that need to be prepared BEFORE the solution is implemented and/or upgraded.

The document has two distinct sections, only ONE of which will be relevant at any point in time:
For NEW implementations, please refer to the steps under “Implement New Environment”
For UPGRADES, please refer to the steps under “Implement Upgrade to Existing Environment”

2. Overview Of Process #

Implementing a new/upgrade version of the BluePrintBI solution will involve any/all of the following steps:

  1. Download the installation and/or upgrade files from our FTP or request an alternative channel by emailing support@blueprintbi.com.
  2. Prepare SQL Server environment or ensure that the test environment complies with the specifications for this release.
  3. Prepare Web Server environment or ensure that the current environment complies with the specifications for this release.
  4. Prepare Desktop environments or ensure that the current environment complies with the specifications for this release.
  5. Backup and restore the databases from PROD to TEST, if applicable. For a new install, restore databases provided.
  6. Ensure SQL permissions for users are in place on restored databases.
  7. Run the SQL scripts on the TEST server (ensure they execute successfully). The order in the detailed release notes may be relevant. Send the execution results to ITSupport@blueprintbi.com.
  8. Update the TEST web server with new version files.
  9. Run the setup.exe for the applications on the TEST machine.
  10. Complete testing for the new release.
  11. Agree on a Freeze period with users on the PROD environment.
  12. Make backups of SQL PROD databases when the freeze period starts.
  13. Run the SQL scripts on the PROD server (ensure they execute successfully). The order in the detailed release notes may be relevant. Send the execution results to ITSupport@blueprintbi.com.
  14. Update the PROD web server with new version files.
  15. Run the setup.exe for the applications on the PROD machines. Clients can make use of their own roll-out process to desktop machines. Alternatively, clients can make use of our Auto Updater (Culminator) to notify client desktops of a new release. The system will then copy the required installation files from a shared network directory and perform the updates on the desktops one by one as the applications are opened for the first time after the upgrade.
    a. Please refer to “First time roll out of Culminator” or “Update Culminator” for further information
  16. User sign-off that release was successful.
  17. Notify all users that the freeze period on PROD has been lifted.
  18. Complete and sign the section under ”Sign of Implementation” and send a copy to support@blueprintbi.com. This will notify us that the release process has been successfully completed.
    Please see detailed steps applicable to each release in the relevant sections below.

3. Installation Files And Structure #

The latest release will be on the following ftp site:
ftp://culminit.dyndns.org/ or ftp://105.242.31.146//
Username : BluePrint
Password : [Supplied on Request]
Find the folder for the relevant release: v7_1_0_125
Each release folder will contain the following subfolders:

BluePrintBI_Online_7_1_0_125.zipWebsite files required to update the Web serverClient IT

4. Environment Requirements #

4.1 Supported Microsoft Versions #

The following versions of the various Microsoft products are supported with this version of BluePrintBI:

Although BluePrintBI can support these product versions, please note that each product version has different build versions, each with its own Active and Security ‘end-of-life’ Support dates.

4.2 Minimum System / Server Requirements #

The list below outlines the minimum hardware and software requirements that need to be in place prior to installing BluePrintBI at a client.

4.2.1 SQL Server #

  • Resources should be allocated to the server/database in consideration of other systems and/or databases that share the same space.
  • Hard Drive space allocated to this database depends on documents that will be uploaded into the database.
  • Windows Server and SQL server versions please see “Microsoft products supported” above.
  • Depending on disaster recovery policy, SQL Express can also be used if automated SQL backup schedules / maintenance plans are not required
  • Disaster recovery, backup schedules and maintenance plans are the responsibility of the client
  • BPBI email account to be used by the system internally to send notifications. This is a once-off optional setup in BPBI and can be a SMTP or Active Directory domain email account.

4.2.2 Web Server #

  • Ram is dependent on the number of concurrent users required
  • Compatible with all Windows versions that support IIS 7 or higher
  • Minimum .NET 4.5 Framework redistributable installed (Full .NET 4.5 not .NET 4.5 client profile)
  • Server Roles and Features – Application development – .NET 4.5 with ASAPI drivers
  • For a client with Active Directory, a Service Account with access to SQL. For a client without Active Directory, a SQL Account used for website authentication.
  • Access security to the web server internally as well as externally is the responsibility of the client.
  • Load balancing and scaling are supported but remain the responsibility of the client.
  • Latest SQL Management Studio (SSMS) installed, only the tool, not the database engine
  • IIS root section unlocks
    • system.webServer/handlers
    • system.webServer/security/authentication/anonymousAuthentication

4.2.3 Workstations #

  • Workstation can be either 32-bit or 64-bit Windows installation.
  • See “Microsoft products supported” above for supported windows operating systems.
  • Minimum .NET 4.5 Framework redistributable installed (Full .NET 4.5 not .NET 4.5 client profile)
  • See “Microsoft products supported” above for supported Microsoft Office versions.
  • Adobe Acrobat viewer (latest)
  • Connection to SQL instance (can be tested with ODBC before installations are done)
  • User must have full read/write access to the installation folder
  • Supported bowsers for BluePrintBI Web Interface
    • Please refer to the “Microsoft products supported” above
  • Microsoft Visio (optional)
    • Please refer to the “Microsoft products supported” above
    • Visio (complete install) only for stations where Visio is to be generated (minimum Standard version)
    • Visio Viewer only for stations where Visio is to be viewed only and not generated
  • Allow access to the following internet address (for license registration):
    • http://bpbiregistration.azurewebsites.net/RegistrationService.svc

4.2.4 Remote Access #

  1. BPBI support team requires remote access to an environment where we can test and/or support any issues with the current or new release at the client.
  2. Copy/Paste to the environment must be allowed.
  3. Machine/VM used for remote access should be treated like a user workstation with all requirements installed as per above stipulation

4.2.5 Important Notes #

  1. A custom location can be entered when installing the application.
  2. If the automatic updater (Culminator) is to be used, a shared network folder is required to which all users must have read access
  3. Screen Resolution: BPBI does not support custom scaling. Scaling should be 100%.
  4. Custom screen layouts created in prior versions of BPBI by the user could cause visibility issues on some screens after an upgrade. The screen layouts need to be reset to update the custom layouts on the upgraded screens. (Top left of screen, click ‘File’ and then ‘Reset Tool Window Layout’. Close and reopen the screen)

4.2.6 Registration Of Each Workstation #

The initial installation of the product on workstations will remain a trial version until registered. Registration can be done in one of three different ways:

  1. Manual registration via email
  2. Desktop registration using the frontend to register the user
  3. Online registration via a website

4.2.7 Manual Registration #

This type of registration can be used when there is no internet connection or the company policy prohibits the external connection to the internet.

  1. An email must be sent with your unique registration ID. For convenience, you can click on the button to copy your ID to the clipboard so that it can be pasted in an email.
  2. Email the unique registration ID to registration@blueprintbi.com.
  3. As subject, please indicate that the email is to request registration of a BluePrintBI instance
  4. In the body of the email, please provide the following:
    • Unique ID : (Paste the ID from the clipboard)
    • Company Name or Department :
    • Name and Surname :
    • Email :
  5. An email reply will then be sent containing the Serial number to use for registration
  6. Highlight the provided serial in the email and copy it to the clipboard (Ctrl + C or Right-Click, Copy)
  7. On the trial screen, click the button which will paste the serial into the correct text blocks
  8. Click on the button to remove trial limitations and register your application as a full version

4.2.8 Desktop Registration #

This type of registration can be used when there is an internet connection available and your security infrastructure allows access to the following link:


Culminit Registration Services

  1. From the trial screen in BluePrintBI, click on the button
  2. This will open the registration form (pictured above)
  3. Enter the Company Name and/or Department for which to register your application
  4. Provide your Name and Last Name in the text blocks provided
  5. Enter your email address in the text block provided
  6. The Authorisation Code will have been provided to your IT Manager and needs to be entered to ensure you are a valid license holder.
  7. Click on the button to have your information validated on our licensing servers
  8. Once the system responds with a confirmation, your application will automatically be registered as a full version to remove the trial limitations.

4.2.9 Online Registration #

This type of registration can be used when there is an internet connection available.

Culminit Desktop Registration

  1. Open a web browser and navigate to the provided link or click on the above link
  2. This will open the registration web page (pictured above)
  3. Enter your Company Name and/or Department for which to register your application
  4. Provide your Name and Last Name in the text blocks provided
  5. Enter your email address in the text block provided
  6. The Authorisation Code will have been provided to your IT Manager and needs to be entered to ensure you are a valid licence holder.
  7. Copy and paste your unique registration ID into the text box provided
  8. Click on the button to have your information validated on our licensing servers
  9. Once the system responds with a confirmation, the Unlock Key text box will be populated
  10. Highlight the provided Unlock Code and copy it to the clipboard (Ctrl + C or Right-Click, Copy)
  11. On the trial screen in BluePrintBI, click the button which will paste the serial into the correct text blocks
  12. Click on the button to remove trial limitations and register your application as a full version

5. Implement Upgrade To Existing Environment #

5.1 Release Summary #

Scheduled release (typically annually) to upgrade to the latest version of BluePrintBI solution and/or sub-systems
Download and extract the update file from the FTP site

  1. BluePrintBI_ 7.1.0.125.zip
  2. All required files will be contained within this archive as per “Installation Files and Structure” table

5.2 Updating SQL Server #

  1. Retrieve files from the FTP site update archive downloaded:
    1. BluePrintBI_DBUpgradeScript_7_1_0_125.sql
    2. BluePrintBI_DBUpgradeScript_SecurityAndPermissions_7_1_0_125.sql
    3. BluePrintBI_StandardQueries_Script_7_1_0_125.sql
    4. If SourceFusion is implemented, then also download these files:
      1. SourceFusion_DBUpgradeScript_2_1_0_23.sql
      2. SourceFusion_ClientIntegration_Script_BluePrintBI_2_1_0_23.sql
      3. SourceFusion_ClientQueries_Script_BluePrintBI_2_1_0_23.sql
    5. If QueryFusion is implemented, then also download these files:
      1. First time rolling out QueryFusion
        1. Baseline_2_2_0_50.sql
        2. QueryFusion_DBUpgradeScript_2_2_0_50.sql
        3. Script.PostDeployment_2_2_0_50.sql
        4. BluePrintBI_QueryFusion_Queries_Script_7_1_0_125.sql
      2. Upgrading QueryFusion
        1. QueryFusion_DBUpgradeScript_2_2_0_50.sql
        2. BluePrintBI_QueryFusion_Queries_Script_7_1_0_125.sql
  2. The following steps must first be completed on the TEST environment and then repeated for PROD after sign-off from the users have been received for TEST:
    1. Ensure that there is a current backup of the PROD database(s) before continuing with the upgrade
    2. Restore the PROD databases over the databases in TEST
    3. Execute script(s) on BluePrintBI database (in this order)
      1. If QueryFusion is implemented:
        1. First time rolling out QueryFusion
          1. Baseline_2_2_0_50.sql
          2. QueryFusion_DBUpgradeScript_2_2_0_50.sql
          3. Script.PostDeployment1_2_2_0_50.sql
          4. BluePrintBI_QueryFusion_Queries_Script_7_1_0_125.sql
        2. Upgrading QueryFusion
          1. QueryFusion_DBUpgradeScript_2_2_0_50.sql
          2. BluePrintBI_QueryFusion_Queries_Script_7_1_0_125.sql
        3. BluePrintBI_DBUpgradeScript_7_1_0_125.sql
        4. BluePrintBI_DBUpgradeScript_SecurityAndPermissions_7_1_0_125.sql
        5. BluePrintBI_StandardQueries_Script_7_1_0_125.sql
        6. Copy the SQL results (messages tab) of the script after execution and mail to ITSupport@blueprintbi.com
      2. Execute script(s) on SourceFusion database (in this order)
        1. If QueryFusion is implemented:
          1. First time rolling out QueryFusion
            1. Baseline_2_2_0_50.sql
            2. QueryFusion_DBUpgradeScript_2_2_0_50.sql
            3. Script.PostDeployment1_2_2_0_50.sql
          2. Upgrading QueryFusion
            1. QueryFusion_DBUpgradeScript_2_2_0_50.sql
          3. If SourceFusion is implemented, then also download these files:
            1. SourceFusion_DBUpgradeScript_2_1_0_23.sql
            2. SourceFusion_ClientIntegration_Script_BluePrintBI_2_1_0_23.sql
            3. SourceFusion_ClientQueries_Script_BluePrintBI_2_1_0_23.sql
          4. Copy the SQL results (messages tab) of the script after execution and mail to ITSupport@blueprintbi.com
      3. If the scripts complete with errors, please inform the BPBI team immediately so that it can be investigated before the roll-out of the application can continue in PROD.

5.3 Updating Workstations #

  1. Retrieve files from the FTP site update archive downloaded:
    1. BluePrintBI_7_1_0_125_setup.exe
    2. SourceFusion_2_1_0_23_setup.exe
  2. The following steps have first be completed on the TEST environment and then repeated for PROD after sign-off from the users have been received for TEST:
    1. BluePrintBI_Online
      1. Make a copy of the current website installation folder on the web server.
      2. Rename folder copy to indicate when backup/copy was made
      3. Extract all the files from BluePrintBI_Online_7_1_0_125.zip into the current website installation folder on the web server, overwriting existing files.
      4. To Encrypt/Decrypt the connection string for the BluePrintBI website, please see “Appendix A“
    2. VisualFusion
      1. Run the VisualFusion_Plugin_1_2_0_47.exe installer
      2. Accept all defaults
    3. QueryFusion
      1. Run the QueryFusion_2_2_0_50_setup.exe installer
      2. Accept all defaults
    4. After successful implementation and testing, please proceed with the production roll-out and sign-off.

5.4 Updating Culminator (Auto Updater) #

This is only required if the client does not have their own implemented process to roll out the new BluePrintBI and SourceFusion applications to existing desktop environments.

Culminator is not used for the TEST environment or for first-time installations on PROD. TEST environments and first-time PROD installations should be manually installed, running the installer files and following the user prompts.
Please take note of the following:

  1. Use Universal Naming Convention (UNC) when specifying file directories for Culminator in the setup.xml file.
  2. The file directory for Culminator’s shared folder is specified in BluePrintBI and SourceFusion on the ‘System Configuration’ screens individually under the ‘Auto Updater’ section, as part of the initial setup/configuration
    1. Please see “Preparing Culminator (Auto Updater)” for the initial setup steps

Steps to update:

  1. Download update files from the FTP site:
    1. Culminator_1_0_1_6_setup.exe
  2. Find the shared network location path used for Culminator (as configured in BluePrintBI System Configuration during initial environment preparation). This location should have the following folders:
    1. AutoUpdater_Updates
    2. BluePrintBI_Updates
    3. SourceFusion_Updates
  3. Paste the Culminator_1_0_1_6_setup.exe installer into the AutoUpdater_Updates folder

5.5 Sign-Off Implementation #

Please send signed document back to support@blueprintbi.com and cc ITSupport@blueprintbi.com after the successful implementation of the release.

5.6 Release Distribution #

5.6.1 Culminator (Auto Updater) #

This is only required if the client does not have their own implemented process to roll out the new BluePrintBI and SourceFusion applications to existing desktop workstation environments.
Culminator is not used for the TEST environment or for first-time installations on PROD. TEST environments and first-time PROD installations should be manually installed, running the installer files and following the user prompts.
Please take note of the following:

  1. The file directory for Culminator’s shared folder is specified in BluePrintBI and SourceFusion on the ‘System Configuration’ screens individually under the ‘Auto Updater’ section, as part of the initial setup/configuration
    1. Please see “Preparing Culminator (Auto Updater)” for the initial setup steps

Steps to update:

  1. Retrieve files from the FTP site update archive downloaded:
    1. BluePrintBI_7_1_0_125_setup.exe
    2. SourceFusion_2_1_0_23_setup.exe
  2. Find the shared network location path used for Culminator (as configured in BluePrintBI System Configuration during initial environment preparation). This location should have the following folders:
    1. AutoUpdater_Updates
    2. BluePrintBI_Updates
    3. SourceFusion_Updates
  3. Copy the downloaded setup.exe files to the relevant locations:
  4. Open the setup.xml file. The section has the following elements:
  1. Retrieve files from the FTP site update archive downloaded:
    1. BluePrintBI_7_1_0_125_setup.exe
    2. SourceFusion_2_1_0_23_setup.exe
  2. Find the shared network location path used for Culminator (as configured in BluePrintBI System Configuration during initial environment preparation). This location should have the following folders:
    1. AutoUpdater_Updates
    2. BluePrintBI_Updates
    3. SourceFusion_Updates
  3. Copy the downloaded setup.exe files to the relevant locations:
  1. Open the setup.xml file. The section has the following elements:
    1. <Product Name>
    2. <ApplicationUpdatePath>
    3. <AppliccationTargetVersion>
  2. Replace the existing version numbers in the “ApplicationTargetVersion” element to the updated value for the relevant product:
    1. For <Product Name> BluePrintBI change <AppliccationTargetVersion> value to 7.1.0.125
    2. For <Product Name> SourceFusion change <AppliccationTargetVersion> value to 2.1.0.23
    3. Take note of the <ApplicationUpdatePath> values for each product. They should refer to the subfolders above, in the shared network location path used for Culminator.
    4. Save the changes and close
  3. Please refer to “Updating SQL Server” to ensure that all required database scripts have been applied on the BluePrintBI and SourceFusion databases
  4. Please refer to “Updating Web Server” for steps to update the centralised support systems

5.6.2 Manual Distribution #

This is only if the client does not use the Culminator (Auto Updater) or another 3rd party utility to roll out the new BluePrintBI and SourceFusion applications to existing desktop workstation environments.

  1. Please refer to “Updating Web Server” for steps to update the centralised systems
  2. Please refer to “Updating Workstation(s)” for the steps to update individual users
  3. Please refer to “Updating SQL Server” to ensure that all required database scripts have been applied on the BluePrintBI and SourceFusion databases

6. Implement New Environment #

6.1 Preparing SQL Server #

  • BluePrintBI is based on a MS SQL Server database. Recommended latest SQL Server, see “Microsoft products supported” above.
  • The SQL Server login used to authenticate users must:
    • Be given SQL permissions
      • db_executor
  • BluePrintBI is based on a MS SQL Server database. Recommended latest SQL Server, see “Microsoft products supported” above.
  • The SQL Server login used to authenticate users must:
    • Be given SQL permissions
      • db_executor
        • Custom role to grant execute permissions for stored procedures
        • CREATE ROLE [db_executor] AUTHORIZATION [dbo];
        • GRANT EXECUTE TO [db_executor];
      • db_datareader
      • db_datawriter
      • db_ddladmin
    • Access to the database(s)
    • dbo default schema assigned
    • Can be Windows or SQL authentication user(s) or group(s)
  • Filestream must be enabled on the SQL instance.
  • Database collation to be used: SQL_Latin1_General_CP1_CI_AS
  • Normal database administration must be applied by the client unless specifically requested from BPBI. This includes tasks such as a backup schedule, database disaster recovery and maintenance plans.
  • Default schema dbo is assigned to all SQL users/groups accessing the database
    • ALTER USER [sqlUserOrGroup] WITH DEFAULT_SCHEMA = dbo;
  • Both the BluePrintBI and SourceFusion databases will be supplied with the initial installation roll-out
    • Database names normally takes the format BluePrintBI_ClientName and SourceFusion_ClientName
  • Once the databases are restored, the logins can be added to the databases
  • Also required is a SQL or Active Directory login/user on the BluePrintBI database used as a service account named svc_BluePrintBI which also has all the above-mentioned permissions applied

6.2 Preparing Workstations #

  1. Retrieve files from the FTP site update archive downloaded:
    1. BluePrintBI_7_1_0_125_setup.exe
    2. SourceFusion_2_1_0_23_setup.exe
  2. Run the installers on each PROD machine to install the applications (preferably using the default locations and options)
  3. Each application shortcut will be placed on the DESKTOP
  4. Double click the icon to open the application
  5. For BluePrintBI, click on the Trial Run button or register the application (see “Registration Steps”) and you will be presented with the Login screen
  6. Setting up the database connection
    1. Click on the Settings button, you will be presented with the SQL connection screen
    2. Select either Windows (Windows Authentication) or Custom (SQL Authentication) and complete the required fields. When OK is clicked, the system will provide feedback to indicate if the connection was successful.
    3. Click the Exit button
    4. The user configuration is stored in the ‘MyDocuments\BluePrintBI\XML’ folder
    5. The ConnectionString.xml config file in the XML folder can be distributed to all users. The same folder structure should be created if not present. Place the file into the same XML folder for each user’s own profile. This will negate the requirement for each user to set up their connection to the database.
  7. The same process can be followed for SourceFusion
    1. The user configuration is stored in the ‘MyDocuments\SourceFusion\XML’ folder
  8. The system is now ready to be used.

6.3 Preparing Culminator (Auto Updater) #

This implementation is only required if the client does not have their own implemented process to roll out the new BluePrintBI and SourceFusion applications to existing desktop environments.
Culminator is not used for the TEST environment or for first-time installations on PROD. TEST environments and first-time PROD installations should be manually installed, running the setup.exe files and following the user prompts.
Please take note of the following:

  1. Use Universal Naming Convention (UNC) when specifying file directories for Culminator in the setup.xml file.
  2. The file directory for Culminator’s shared folder is specified in BluePrintBI and SourceFusion on the ‘System Configuration’ screen, Auto Updater section.

Steps to implement:

  1. Create shared folders on the network
  1. Create shared folders on the network
    1. Centralised shared folders are required to distribute updates. This location must be accessible with Read permissions by the SQL Server, IIS Server as well as all workstations
    2. Folder1: AutoUpdater_Updates
    3. Folder2: BluePrintBI_Updates
    4. Folder3: SourceFusion_Updates
  2. Test the shared folders
    1. Navigate to the UNC path \{ComputerName_or_IP}\AutoUpdater_Updates
    2. Navigate to the UNC path \{ComputerName_or_IP}\BluePrintBI_Updates
    3. Navigate to the UNC path \{ComputerName_or_IP}\SourceFusion_Updates
  3. Retrieve files from the FTP site update archive downloaded and place in respective shared folders:
Shared FolderFiles
AutoUpdater_UpdatesCulminator_1_0_1_6_setup.exe
Setup.xml
BluePrintBI_UpdatesBluePrintBI_7_1_0_125_setup.exe
SourceFusion_UpdatesSourceFusion_2_1_0_23_setup.exe
  1. Edit the setup.xml configuration file
    1. The configuration file consists of a section which has the following elements:
      1. <{Product Name}> – Unique name of the application to update
      2. <ApplicationUpdatePath> – UNC path where the installer can be found
      3. <ApplicationTargetVersion> – Version of current system
    2. Supply the UNC file paths for both the BluePrintBI and SourceFusion product sections
    3. Supply the version number 7.1.0.125 for BluePrintBI and 2.1.0.23 for SourceFusion
    4. Example for the contents:
      • <setup>
        • <BluePrintBI>
        • <ApplicationUpdatePath\\{ComputerName_orIP]\BluePrintBI_Updates<ApplicationUpdatePath>
        • <ApplicationTargetVersion>7.1.0.125</ApplicationTargetVersion>
        • </BluePrintBI>
        • <SourceFusion>
        • <ApplicationUpdatePath\\{ComputerName_orIP]\SourceFusion_Updates<ApplicationUpdatePath>
        • <ApplicationTargetVersion>2.1.0.23</ApplicationTargetVersion>
        • </SourceFusion>
      • </Setup>
    5. Ensure that the latest database scripts have been applied to the database before continuing
    6. Install BluePrintBI on a PROD machine and connect to the relevant BluePrintBI database. Please refer to the step under ‘Setting up the database connection’
    7. Install SourceFusion on a PROD machine and connect to the relevant SourceFusion database. Please refer to the step under “Setting up the database connection”
    8. Open each application and log into the system, navigate to the ‘System Configuration’ screen and under the ‘Auto Updater’ section, supply the UNC path where the Culminator installer is located i.e., \{ComputerName_or_IP}\AutoUpdater_Updates
    9. Save Changes and close the application
  2. This is a once-off setup as all users will be connecting to the same database and thus will retrieve this setting when they log into the database.
  3. When the user logs into the application
    1. The system navigates to the Culminator shared location.
    2. Checks if the latest Culminator is installed, if not, copies the installer to the workstation and silently installs the latest version.
    3. Once installed, it checks the setup.xml file in the Culminator shared location for the application being started.
    4. It compares the current application version with the required version in the configuration file and if they differ, attempts to retrieve the installer from the UNC path for the application as provided in the configuration file.
    5. The installer is copied over to the workstation and silently installs the version.
    6. Once installed, the user is presented with the login screen for the application.

6.4 Preparing Web Server #

6.4.1 Required Information And Pre-Setup #

  • Active directory or server local user service
    • used for SQL and domain authentication of website
    • account should be added to the SQL group that has access to the BluePrintBI and SourceFusion databases
  • DNS redirect entry with port (optional)
    • used to alias website within intranet for easier access to users
  • Folder on IIS web server where the website can be deployed to i.e., C:\BluePrintBI
    • Create sub-folder BluePrintBI_Online and deploy the website files copied from the FTP site
    • Ensure that the ‘IUSR’ user has been added to the security for the folder and allow ‘Full Control’

Please refer to “Updating Web Server” on how to procure the deployment files

6.4.2 BluePrintBI WebViewer Installation Steps #

  1. Please first read “Required Information and pre-setup”
  2. Ensure that all required features have been installed on IIS
    1. Open Server Manager – Local Server
    2. Scroll down to ‘Roles and Features’
    3. Click ‘Tasks’ – ‘Add Roles and Features’
    4. Server Roles
      • Web Server (IIS)
        • Web Server
          • Application Development
          • .NET Extensibility 4.5
          • ASP.NET 4.5
          • ASAPI Extensions
          • ISAPI Filters
    5. Features
      • .NET Framework 4.5 Features
        • .NET Framework 4.5
        • ASP.NET 4.5
  3. Open IIS Manager
  4. Stop ‘Default Web Site’
    1. Connections Panel (left-hand panel)
    2. Open ‘Sites’ List – Select ‘Default Web Site’
    3. Stop the website in the Actions panel (right-hand panel)
  5. Stop ‘Default Application Pool’
    1. Connections Panel (left-hand panel)
    2. Open ‘Application Pools’ – Select ‘DefaultAppPool’
    3. Stop the pool in the Actions panel (right-hand panel)
  6. Add Application Pool
    1. Connections Panel (left-hand panel)
    2. Right click ‘Application Pools’ – ‘Add Application Pool’ – ‘Add Application Pool’ Dialog
      1. Name : BluePrintBI_Online
    3. ‘Actions’ panel – ‘Advanced Settings’ – ‘Advanced Settings’ dialog
      1. Scroll to ‘Enable 32-Bit Applications’ and set to ‘True’
      2. Scroll to ‘Start Mode’ and select ‘AlwaysRunning’
      3. Scroll to ‘Identity’ click on ‘…’
        1. IF USING SQL AUTH
          1. Select ‘Built-in Account’ – ‘LocalService’
        2. IF USING AD
          1. Select ‘Custom Account’ – ‘Set’
          2. Enter service account DomainName\AccountName and password
        3. IF USING LOCAL ACCOUNT
          1. Select ‘Custom Account’ – ‘Set’
          2. Enter service account WebServerComputerName\AccountName and password
      4. Accept changes by clicking ‘OK’
  7. Add Website
    1. Connections Panel (left-hand panel)
    2. Right click on ‘Sites’ list – ‘Add Website’
    3. Add Website Dialog
      1. Site Name : BluePrintBI_Online
      2. Application Pool : BluePrintBI_Online
      3. Physical Path : Select path where website was copied i.e., ‘C:\BluePrintBI\BluePrintBI_Online’
      4. Connect As : Select ‘Pass Through’
      5. Click ‘Test Settings’, should have 2 green ticks
      6. If client uses their own DNS redirect internally
        1. Host Name: redirect URL provided by client i.e., ‘blueprintbi_online.internal.co.za’
        2. IP Address: As provided by the client (if applicable)
      7. Click ‘OK’
      8. If ‘Duplicate port binding’ Warning, click ‘OK’ and accept
  8. Get DNS server name for AD authentication details for appsettings.config
    1. Open command prompt (as administrator) on the web server
    2. Execute ‘nslookup’
    3. Note the domain and extension portion of the computer name i.e., computername.domainname.co.za
    4. Type ‘exit’ and execute
    5. Close the command prompt
    6. Open the network and sharing dialog and check the DNS IP for the current network address
  9. Update website appsettings.config
    1. Connections Panel (left-hand panel)
    2. Under the ‘Sites’ list – right click on ‘BluePrintBI_Online’ – select ‘Explore’
    3. Locate CustomConfig\appsettings.config file and edit in Notepad
      1. Locate ‘appSettings’ – key ‘DefaultActiveDirectoryServer’
        1. Update value to LDAP://DNS_Server_Name.ext using previous step information
      2. Locate ‘appSettings’ – key ‘SecondaryActiveDirectoryServer’
        1. Update value to the DNS IP using the previous step information
  10. Update website connections.config
    1. Connections Panel (left-hand panel)
    2. Under the ‘Sites’ list – right click on ‘BluePrintBI_Online’ – select ‘Explore’
    3. Locate CustomConfig\connections.config file and edit in Notepad
      1. Locate ‘connectionStrings’ – key ‘Main’
      2. Update the ADO SQL connection accordingly by supplying the appropriate Data Source and Database values
      3. If SQL authentication is used, Trusted_Connection=True; si replaced with user id={sql_username};password={pw};
  11. Once both files (appsettings.config and connections.config) are updated, cut / paste (move) the 2 .config files into the website root folder
    1. This is the same folder where all the website files are located including the web.config
  12. Ensure all relevant IIS features are unlocked
    1. Connections Panel (left-hand panel) – click on the IIS root server node
    2. Under the ‘Management’ group, double click ‘Configuration Editor’
    3. Navigate to section ‘system.webServer/handlers’
      1. Right-hand panel, click ‘Unlock’ section
    4. Navigate to section ‘system.webServer/security/authentication/anonymousAuthentication’
      1. Right-hand panel, click ‘Unlock’ section
  13. Ensure authentication is setup correctly
    1. Connections Panel (left-hand panel)
    2. Select ‘BluePrintBI_Online’ website from the ‘Sites’ list
    3. Under the ‘IIS’ group, double click on ‘Authentication’
    4. Right click ‘Anonymous Authentication’ – Select ‘Edit’
    5. Select ‘Application pool identity’
    6. Ensure that the service account is added to the BluePrint Database for authentication
      1. Open SSMS
      2. Connect to the SQL server and navigate to the BluePrintBI database
      3. Open ‘Security’ – ‘Users’
      4. Service account should be in the list of valid users or be part of the group that is assigned to the database
    7. Test configuration
      1. Connections Panel (left-hand panel)
      2. Select ‘BluePrintBI_Online’ website from the ‘Sites’ list
      3. On the ‘Actions’ panel (right-hand panel)
        1. Select ‘Restart’
        2. Click on ‘Browse Website’
      4. Login using BluePrintBI credentials
      5. Logout
      6. Login using domain account details (associated with a BluePrintBI user)

6.4.3 VisualFusion Installation Steps #

  1. Please first read “Required Information and pre-setup”
  2. Run the VisualFusion_Plugin_1_2_0_47.exe installer
    1. Preferably on the same IIS server where BluePrintBI_Online website was rolled out to
    2. BPBI team will need access to the installation folder from time to time
  3. Accept all defaults
  4. Ensure that the installation folder has been shared and that all relevant parties can access the shared UNC path
    1. i.e., \{computer name or IP}\VisualFusion_Plugin
    2. This is the path to use when updating the BluePrintBI system configuration through the desktop client
  5. Test roll-out
    1. Open the BluePrintBI Web Viewer site
    2. Generate a process flow or hierarchy diagram from the process trees
    3. If the plugin was correctly rolled out and BluePrintBI correctly setup/configured, a PDF of the requested diagram is downloaded (or prompt given to request saving location for the file)

6.4.4 QueryFusion Installation Steps #

  1. Please first read “Required Information and pre-setup”
  2. Run the QueryFusion_2_2_0_50_setup.exe installer
    1. Preferably on same IIS server where BluePrintBI_Online website was rolled out to
    2. BPBI team will need access to the installation folder from time to time
  3. Accept all defaults
  4. Ensure that the installation folder has been shared and that all relevant parties can access the shared UNC path
    1. i.e., \{computer name or IP}\QueryFusion_Plugin
    2. This is the path to use when updating the BluePrintBI system configuration through the desktop client
  5. Test roll-out
    1. Open the BluePrintBI desktop client
    2. Refer to the help manual on how to setup QueryFusion using the desktop client
    3. Open the queries from the health check tab
    4. This should open the QueryFusion interface

6.5 Configuring Email Notifications #

There is a once-off setup required in the BluePrintBI System Configuration to enable email notifications to be sent from within the system. The client can use a Microsoft Exchange or a SMTP email account.

  1. Open and log into BluePrintBI using a BluePrintBI user that has appropriate permissions to edit the system configuration
  2. From the Main Menu, click on the Setup tab and select ‘System Configuration’
  3. Click ‘Edit’ in the ribbon bar and then select the ‘Email’ tab

6.5.1 Use The MS Exchange Setup #

  1. Click the red “X” button in the lower left-hand corner of the Active Directory group
  2. Complete the following properties before clicking the “Save” button:
    • SMTP Host Address : Exchange controller host address i.e., mail.company.co.za
    • SMTP Port : 25 is the default port number
    • Username : Email account/address that will be used to send the notifications
    • Password : Password for the account

6.5.2 Use The SMTP Setup #

  1. Click the red “X” button in the lower left-hand corner of the SMTP group
  2. Complete the following properties before clicking the “Save” button:
    • SMTP Host Address : SMTP server address i.e., smtp.emailprovider.com
    • SMTP Port : 587 is the default port number
    • Username : Email address that will be used to send the notifications
    • Password : Password for the account
    • Use SSL : Normally should be false
    • USE Default Credentials : Normally should be true

Note that the BluePrintBI SMTP account details are used by default, but can be changed to a client account if so required.

7. Appendixes #

7.1 Appendix A: Encrypt / Decrypt WEbsite Database Connections Configuration File #

The encryption / decryption of the connections.config file contents which are used to authenticate the SQL database connection of the website. The connection string could contain sensitive data.

  1. From the website root folder on the IIS Server
    1. To locate the folder, open IIS, right click on the relevant website and select Explore
  2. Ensure the 3 following files are present in the root folder (if not, go to point 3)
    1. Identity.aspx
    2. IdentityEncrypt.bat
    3. IdentityDecrypt.bat
  3. If the files are not in the root folder
    1. Navigate to the folder {RootFolder}\WebConfigEncrypt and copy the files into the {RootFolder}
  4. In IIS, browse the website so that it opens in a Web Browser
    1. In the address bar, replace the ‘/Login’ or ‘/Default’ postfix with ‘/identity.aspx’ and press enter to navigate to the identity page
    2. Note down the identity and web folder path details presented (copy to Notepad)
  5. From the {RootFolder}
    1. Encryption
      1. Right click the IdentityEncrypt.bat file and select ‘Run As Administrator’
      2. From notepad, copy the identity value and paste into the command prompt window as requested, press enter
      3. From notepad, copy the website folder path and paste into the command prompt window as requested, press enter
      4. Response should be similar to:
        1. Adding ACL for access to the RSA Key container…
        2. Succeeded!
        3. Encrypting configuration section…
        4. Succeeded!
        5. Press any key to continue…
    2. Decryption
      1. Right click the IdentityDecrypt.bat file and select ‘Run As Administrator’
      2. From notepad, copy the identity value and paste into the command prompt window as requested, press enter
      3. From notepad, copy the website folder path and paste into the command prompt window as requested, press enter
      4. Response should be similar to:
        1. Adding ACL for access to the RSA Key container…
        2. Succeeded!
        3. Decrypting configuration section…
        4. Succeeded!
        5. Press any key to continue…

7.2 Appendix B: Architechture Layout #

Powered by BetterDocs