Skip to main content

Step 2: Installation

Run the install kit, it will install and configure the SigmafineHub.

  1. Log on to the application server, using a domain user account that belongs to the local Administrators group.

  2. Copy the SFHub.exe file on the file system.

  3. Run the SFHub.exe to launch the installation wizard and open the Welcome page.

    Welcome page

  4. Click Next to open the License Agreement page.

    License Agreement page

  5. Select I accept the terms in the license agreement.

  6. Click Next to open the (IIS) Application Pool Configuration page.

    Application Pool Configuration page

    This page allows you to assign the identity entered to the SFHubAppPool.

    We recommend using the same credentials as the SFHubService account.

    tip

    Ignore following warning message for new SFHub installation

  1. In the Username box, type the name you are using for the service account (SFHubService).

  2. In the Domain box, type the Azure Active Directory Domain name associated with the service account username.

  3. In the Password box, type the password associated with the service account user name.

  4. In the Verify Password box, retype the same password.

    Note

    If the selected user has an expiring password you receive a warning when you click on Next. You can either go back and use a different user account or continue, knowing that it may cause issues. Click No to go back and use a different account, or OK to continue.

    Application Pool user has an expiring password message

  5. Click Next to open the Tenant User Information page.

    Tenant User Information page

    This page allows you to define which Domain User is to be the "Tenant" user. The Tenant user is the first user of the SigmafineHub application. This user has all the privileges needed to initially configure the application itself (add user and define their access rights).

  6. Check the Use Application Pool credentials box, to auto-fill the tenant username and domain with the ones previously configured for the service account.

  7. In the User name of tenant user box, type the actual log in name of the Tenant user.

  8. In the Domain of tenant user box, type the name of the Domain of the Tenant user.

  9. Click Next to open the Web Socket Port page.

    Web Socket Port page

    This page allows you to define the TCP ports used by the Web Socket and the TCP port used for SFHub Inter Process Communication between services.

  10. In the Web Socket Port box, type the number of a free TCP port that could be used by the SFHub application server (See "Step 1: Preparation, Open the Required Port").

    Note

    The selected TCP ports must be configured in the Firewall Inbound Rules of the Windows Server, to allow the inbound network traffic.

  11. In the IPC Socket Port box, type the number of a free TCP port that could be used by SFHub Inter Process Communication (See "Step 1: Preparation, Open the Required Port").

    Note

    The selected TCP ports must be configured in the Firewall Inbound Rules of the Windows Server, to allow the inbound network traffic.

  12. Click Next to open the Destination Folder page.

    Installation Destination Folder page

    The Destination Folder is the folder in which the application files are to be installed.

  13. Leave the default folder or click Change to select an alternate installation destination folder.

  14. Click Next to open the SFHub Database Creation and Connection page.

    SFHub Database Creation and Connection page

  15. Select the mode to use to create or update the SFHub database.

    • Managed by the installer (Recommended): Connect to the SQL Server instance to create and configure the SFHub database.

    • Manual SQL Script Execution: Download the script, install it on the SQL Server instance and confirm the creation of the SFHub database. The installer can then check if the database created is consistent.

  16. Select the method SFHub should use to connect to the SQL database.

    • Integrated Security (Use ISS App Pool Windows Identity): SFHub will connect to the SQL Database using SQL Server integrated security, and using the SFHub Application Pool Windows credentials (set in steps 7-10).

    • SQL Server (Use internal SFHubSql user): SFHub will connect to the SQL Database using an internal SQL Server user.

  17. Click Next to open the corresponding database creation page.

    Depending on which mode you selected in the previous step, different steps are required. Follow the steps for the mode you have selected.

    Managed by the installer (Recommended)

    In this mode, you are required to provide a valid SQL Server instance and the associated credentials to be used by the installer to create or update the SFHub SQL database. Ensure that the credentials you provide have the correct SQL grants for creating and altering SQL databases.

    Database Server page

    a. Click the Database server that you are installing to down-arrow and select the SQL Server instance where the SFHub database is to be created.

    OR

    Click the Browse button and select the SQL Server instance where the SFHub database is to be created. You can also just type the SQL Server instance name.

    Browse - Server selections

    b. Click on the Connect using method to use for connecting to the server.

    • Windows authentication credentials of current user: If you select this method, ensure that the Windows user name that is being used to run the setup (this installation), has the required admin rights on the selected SQL Server instance.

    • Server authentication using the Login ID and password below: If you select this method, the connection must have the Admin privileges over the selected SQL Server instance, in order to successfully complete the installation. Type the Login ID and Password to be used.

    c. Optionally you can specify a different name for the database catalog to be created (SFHub is the default name).

    Manual SQL Script Execution

    In this mode, you are required to download and execute the SQL Scripts to create or update the SFHub SQL database.

    Manual Database Creation or Update page

    a. Click the 'Database server to check the installation' Browse button and select the SQL Server instance where the SFHub database is to be created or updated, or just type the SQL Server instance name in the box.

    b. Optionally you can specify a different name for the database catalog to be created by the SQL script (SFHub is the default).

    c. Click the 'SQL Scripts Destination Folder' ... (ellipsis) button and select the appropriate folder.

    d. Click the Download SQL Script button to download the SQL scripts that needs to be executed on the selected SQL server instance. The installer understands the required scripts that need to be executed.

    1. When the download completes, you receive a confirmation message; click Ok.

      SQL Scripts successfully downloaded

    2. Navigate to the 'SQL Scripts destination folder' you selected.

    3. Locate and Unzip the file SFHub_SQL.zip.

    4. Execute all the .sql files on the selected SQL Server instance, respecting the numeric order in the files name.

  18. Click Next to open the License File page.

    License File page

    This page requires the file containing the license key to be installed. If your license file is not available, you can skip this step (the license file can be provided later, see Step 4: License).

  19. Click the Change button and select the license file provided by Pimsoft.

    Note

    After clicking Next, if the Sigmafine Client is not already installed on the SFHub server, the following message appears, informing you that the Sigmafine Client will be installed. Click Ok.

    Client Installation not found message

  20. Click Next to open the Installation Recap page.

    Installation Recap page

    Ensure that the information is correct.

  21. Click Next to open the Ready to Install page.

    Ready to Install the Program page

  22. Click Install.

    An Installing Pimsoft SigmafineHub page opens showing the progression status of the installation.

    Installing Pimsoft SigmafineHub page

    When installing the upgrade to SFHub 2.0 (or later), setup may show the following message:

    SFHub Installer has reset your SFHub displays permissions in order to finish the update.\ Please log in to your SFHub Admin application with the tenant user to set the display shares and permissions.

    The reason for this message is that starting with SFHub 1.6, the installer attempts to assign the display permissions to the SFHub registered users according to the information available in the SFHub database. Whenever this information is not sufficient to determine the permissions, the installer then assigns the full rights to the SFHub Tenant User.\ The Tenant User can later assign the display permissions to each SFHub user through the SFHub Visualizer application (see "Display Properties" and "Share Display" in the SigmafineHub Visualizer User Guide).

  23. Click Next to open the Installation Completed page.

    Installation Completed page

    Note

    The "Show the Windows Installer log" checkbox is visible only if you have ‘Logging’ string key = voicewarmupx in your Windows Registry under Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Installer.

    By checking the Show the Windows Installer log checkbox, the Windows Installer Log opens after you close the last page.

  24. Click Next to open the Verify Installation page.

    Verify Installation page

    This page shows the results of post installation automatic tests.

    • SFHub SQL Standard Connection: Checks the connection to the SFHub SQL Database using the internal SQL Server user. If you selected "SQL Server (Use internal SFHubSql user)" in step 22, this must show "Success" as result.

    • SFHub SQL App Pool Integrated Security: Checks the connection to the SFHub SQL Database using the Windows integrated security with the SFHub App pool user credentials set in steps 7-10). If you selected "Integrated Security (Use ISS App Pool Windows Identity):" in step 22, this must show "Success" as result.

    • SFHub SQL Functions and Procedures: Checks that all the SFHub Stored Procedures and functions are created correctly on SFHub database. This must show "Success" as result.

    • SFHub SQL Tenant User: Checks who is the tenant user and if it's enabled on SFHub database. This must show "\<Tenant User> Enabled: True" as result.

    The remaining row shows where the SFHub installation log is stored. If one of these tests display an unexpected result, please see the log files and contact

  25. Click Next to open the Post Installation Steps page.\

    SFHub Post Installation Steps page

    This page displays the manual steps that you need to do, after the first installation setup kit has been executed.

  26. Click Finish to close the page and finish the installation.

Last updated on