-
Notifications
You must be signed in to change notification settings - Fork 9
Setting up the DIRECT GUI
This document provides details for deploying the DIRECT Graphical User Interface (GUI) application of the ETL Framework. The DIRECT GUI application has been created using Microsoft Lightswitch and is developed to be hosted on the Microsoft Internet Information Server (IIS).
The GUI has been around for a long time, and is in need of re-development since the current version uses Silverlight which has since been deprecated by Microsoft.
Ensure that the Lightswitch components for IIS have been installed on the server/machine hosting the DIRECT GUI website (in IIS). These can be installed using the Web Platform Installer (WPI). The version that includes the local SQL Express is required. The name of the component is ‘LightSwitch in Visual Studio with local SQL Express’.
Before the DIRECT GUI can be installed, the repository needs to be deployed and accessible. DIRECT is designed to operate independently, and does not need the GUI to function. However, if the GUI is deployed as well this requires the creation of additional database objects to support GUI functionality. These scripts are available in the DIRECT GUI solution as the ‘OMD_UI_DB_SCRIPTS.sql’ file.
The following objects will be deployed:
- vw_OMD_EXECUTION_LOG
- vw_OMD_EXECUTION_LOG_EVENT_LOG
- vw_OMD_EXECUTION_LOG_MODULE_INSTANCE
- usp_OMD_BATCH_INSTANCE_FIX_INDICATORS
- usp_OMD_MODULE_INSTANCE_FIX_INDICATORS
- Create a folder named ‘ETL_Framework’ (or equivalent) in the location that is accessible by IIS. For example in C:\inetpub\wwwroot.
- Copy all files from the directory where the zip file as extracted into the newly created directory of the previous step (‘ETL_Framework’ in this example).
- Open IIS Manager, connect to the Server Connection. In the Default Web Site, click on Add Application.
- Configure the Application in IIS:
- Alias Name: ‘ETL_Framework’.
- Application Pool: select or create a pool which runs under ASP.NET v4.0.
- Physical Path: the path where the ‘ETL_Framework’ directory was created. This directory contains all the bin and web config files. For example C:\inetpub\wwwroot\ETL_Framework.
Once the application is deployed the Connection Strings to the DIRECT database can be configured from within IIS. In IIS double-click the Application ‘ETL_Framework’ in the Default Web Site menu. After this double-click on the Connection Strings icon to configuring the database connectivity.
Be aware there is an additional Connection String (LocalSqlServer). Lightswitch requires this to be able to update an existing database, which is not required for this application. For this purpose a dummy Connection String is used. This can contain any name or user credentials.
It can be configured to connect to the same database but the concern that it may update the database or make some changes in the database driven by LightSwitch. A dummy connection has been used for this purpose. The _InstrisicData connection is added to a LightSwitch application by default. Only the C900_OMD_FrameworkData connection requires further customisation.
Click on ‘Edit’ in the Action Menu to modify the database connections.
Click the link ‘Browse *.80 Http’ in the Manage Application Menu on the right side of the page in order to start the Application in the browser. This has the same result as navigating to the site directly.
If issues are still encountered, please check the following:
IIS Components Ensure that the Lightswitch components for IIS have been installed on the server/machine hosting the DIRECT GUI website (in IIS). These can be installed using the Web Platform Installer (WPI). The version that includes the local SQL Express is required. The name of the component is ‘LightSwitch in Visual Studio with local SQL Express’.
Error message: Load operation failed for query ‘GetAuthenticationInfo’ Ensure that the WCF Data Services 5.0 for OData V3 option is available / installed. Download instructions can be found here: http://www.microsoft.com/en-us/download/details.aspx?id=29306. After installation of this component, the website must be restarted in IIS.
Availability of OMD views and procedures Ensure that the required views and Stored Procedures are available in the OMD database. The following views should be present:
- vw_OMD_EXECUTION_LOG
- vw_OMD_EXECUTION_LOG_EVENT_LOG
- vw_OMD_EXECUTION_LOG_MODULE_INSTANCE
If these views are not present the EXECUTION_LOG screens will not show any records.
The following Store Procedures should be present:
- usp_OMD_BATCH_INSTANCE_FIX_INDICATORS
- usp_OMD_MODULE_INSTANCE_FIX_INDICATORS
These Stored Procedures provide the functionality behind the ‘fix Execution Status Code’ button in the Execution Log screen.