Enterprise Data Warehouse (EDW) Configuration

EDW is currently only available for use with Windows OS and Microsoft SQL Database.

Before using your Business Intelligence (BI) tool to collect data on your printing environment, there are some steps to configure the Enterprise Data Warehouse (EDW). Once configured, the EDW utility will extract, transform, and load data from printers and then deploy it to the SQL server. This data is used with your BI tool to create custom reports on your printing environment. The following steps will guide you through this configuration.

Prerequisites

The prerequisites are required to configure the PrinterLogic EDW. Once you've configured the EDW utility, using the provided EDW Dimensions should be done per the functionality of your BI tool.

  • Have admin access to your Microsoft SQL database.
  • Download the EDW Tool.
  • Must be using SQL server - version 2016 SP1 or above (If using Windows 11, Microsoft SQL Server 2019 must be used).
  • Use Windows 2012+ server, Windows 10, and Windows 11 (Windows 11 must use Microsoft SQL Server 2019).
  • Access to Microsoft SQL Server Management Studio (Recommended).

Configure Microsoft SQL Server

This documentation is written using Microsoft Windows Server 2019 with SQL Server 2019 Standard. Additionally, use of SQL Server Configuration Manager tool is suggested.

Microsoft SQL Server Management Studio Settings

  1. Open the Microsoft SQL Server Management Studio, and connect it to your SQL server.

  2. In the left menu, select Security.

    MySQL server window with an arrow pointing to the Security folder in the expanded Object explorer tree view.

  3. Right-click on Logins, and select New Login.

    MySQL server window showing the Security folder expanded, the Logins sub-folder after being right-clicked to expand additional options, and an arrow pointing to the New Login option within the expanded options.

  4. Enter a unique name in the Login name field.

    Login New window with the Login Name field highlighted near the top, and additonal settings displayed below.

  5. Select the SQL Server authentication option.

    Login New window with an arrow pointing to the SQL Server Authentication field.

  6. Enter and then confirm a Password in the appropriate fields.

    Login New window with the Password and Confirm Password fields highlighted and filled in.

  7. In the same screen, select the Server Roles option.

    Login New window focused on the Select a Page options to the middle left, and an arrow pointing to the Server Roles setting.

  8. Check the boxes for public and sysadmin.

    Server Roles page with arrows pointing to the checkboxes for Public and SysAdmin.

  9. Click on OK.

    Server Roles page with the Public and SysAdmin options selected, and an arrow pointing to the OK button in the lower right.

  10. Right-click on the database in the left menu and select Properties.

    MySQL Server Object Explorer page showing the server object options at the top that display after being right-clicked, and an arrow pointing to the properties option at the bottom.

  11. Select Security.

    Server properties window with an arrow pointing to the Select a page - Security option in the upper middle.

  12. Select the option for SQL Server and Windows Authentication mode.

    Server properties window with an arrow pointing to the SQL Server and Windows Authentication mode setting.

  13. Click on OK.

SQL Server Configuration Manager Settings

  1. Open your SQL Server Configuration Manager App.

    SQL Server Manager window showing the manager highlighted in the left tree view.

  2. Under the SQL Native Client 11.0 Configuration option, select Client Protocols.

    SQL server manager window with an arrow pointing to the SQL Native Client 11 Configuration's sub-option for Client Protocols.

  3. Ensure that Shared Memory, TCP/IP and Named Pipes are all Enabled.

    SQL Server Manager Client Protocols page showing Shared Memory, TCP/IP, and Named Pipes as enabled.

Confirm Services are Running

Ensuring that the services are running is crucial and a first step that should be taken if troubleshooting any issues that you may have with data flowing to the database.

  1. Open your Services Manager.
  2. Ensure that the following are all running and set to an Automatic Start-up Type:
    • SQL Server
    • SQL Server Agent
    • SQL Server Browser
    • EDW_Service

    Window's Services window showing the EDW_Service, SQL Server, SQL Server Agent, and SQL Server Browser services running.

Install the EDW Tool

If not previously downloaded, download the tool here: EDW Tool Download

  1. Run the downloaded executable file to install the EDW Tool with your file location preferences.

Generate Token

  1. In your Admin Console, select Tools then Tokens then API Keys.

    Admin Console with the Tools menu expanded, the sub-option of Tokens selected, and the next sub-option for API Keys highlighted.

  2. Click the Generate button.

    API Tokens tab with the Generate button highlighted in the upper left.

  3. The newly generated token will be displayed in the list of Active API Keys below.

    API Keys tab with a token, last time used column, created column, and actions trash can icon highlighted in the Active API Keys section.

  4. Click the View Tokens button to display the active token.

    API Keys tab with the View Tokens button highlighted in the lower left.

  5. Copy the token for use later in this process.

    API Keys tab showing the tokens, and the Hide Tokens button is highlighted in the lower left.

Configure the EDW Utility

  1. Open the EDW Utility console.

    EDW Console showing the different empty fields.

  2. In the PrinterLogic URL field, open the drop-down and ensure the URL for your region is selected. For example, US region would select https://edw.app.printercloud.com.

    Ensure the domain listed is correct for your geographic region:

    • United States - https://edw.app.printercloud.com
    • EMEA - https://edw.app.printercloud5.com
    • APAC - https://edw.app.printercloud10.com
    • Canada - https://edw.app.printercloud15.com

    EDW Console with the EDW URL highlighted in the upper right.

  3. In the Generated EDW Token field, enter the token you copied in the PrinterLogic Admin Console.

    EDW Console with the EDW Token field highlighted and filled in.

  4. Click on the Test button to confirm that the EDW Tool is connected with your PrinterLogic instance.

    A good test will display Successfully connected, EDW token is valid.

    EDW Console with an arrow pointing to the Test Button underneath the Generated EDW Token field.

  5. In the SQL Server Host or IP Address field, enter the IP address or SQL server host that will be used for your printing data.

    EDW Console with the SQL Server Host or IP Address field highlighted and filled in.

  6. In the Username and Password fields, enter the credentials you set in the Microsoft SQL Server Management Studio in the first section of this documentation.

    EDW Console with a box highlighting the username and password fields in the lower right.

  7. In the Optional Params field, add any of the following:

    • TIMEOUT:<timeout in seconds> - If not specified, the default timeout for SQL commands is 30 seconds.
    • DEBUG: <True or False> - If not specified, the default value is False. When this is set to true, SqlPackageDiagnostics.log is created in C:\Program Files\Vasion\EDW Tool folder and debug information will be logged in Event Viewer for EDW_Service.
    • LOG_OVERWRITE: <True or False> - If not specified, the default value is False. When this is set to true and DEBUG is set to true, SqlPackageDiagnostics.log will be overwritten; otherwise, the log messages will be appended.

  8. Click on the bottom Test button to confirm you are connected to the SQL database.

    EDW Console with arrows pointing to the Test button in the lower right, and underneath the SQL Server Host or IP Address field where a Connected! message is displayed.

  9. Click on Add as New Instance to start the process of building the EDW Table. This will also move the PrinterLogic URL into the section titled My PrinterLogic Instance Configs.

    EDW Console with a box around the Add as New button in the lower right.

Follow the steps above to add any additional PrinterLogic instances.

The Add as New Instance / Update Selected Instance button saves the configuration and updates the database.
If you have updated configuration parameters but aren't ready to update the database, click the Save button, as it only saves the selected configuration values on the right.

Hotkeys

  1. Press the "Alt" key to make hotkeys appear.

  2. Press Alt + <underlined letter> to set the focus on the specific control desired.

    When the configuration is selected, pressing the space bar will select and deselect some values.

Confirm Build

  1. Return to your Microsoft SQL Server Management Studio.

  2. Under Databases, confirm that PrinterLogic EDW is listed.

    Data may not immediately show until a second cycle has run. However, the EDW_Service could be restarted manually to force the cycle to start. Otherwise updates to the data displayed will happen every 15 minutes by default.

  3. Queries can now be made in the database.