BDX Reports Install and Setup Guide

Transcription

1 BDX Reports Install and Setup Guide Introduction: This manual will take you through the process of installing, setting up and using Report ScoreCards for BDX. BDX Reports is a Client Services Application which performs analysis on data collected from devices and creates score cards based on the results. These score cards are used to identify problems or inefficiencies with a device over a specific time period. The BDX Reports application resides within the BDX server and utilizes the BLX Niagara Basix Templates and BLX Niagara Agent. Prerequisites and requirements: - Existing BDX installation (see Data Exchange Install and Setup Guide) - Computer running Windows Operating System with internet access - Administrator privileges - Basic understanding of computers and networking - Niagara WorkPlace AX - Working station with points or templates - Detailed information about the devices - Web browser with Adobe Flash Player installed - Registered account on Checklist: Jace, or computer running Soft Jace or Web Sup Working station BDX Installation Database scripts BLX Basix JAR for Niagara Reports Server EAR for Glassfish BDX license for Reports Niagara Basix templates licenses Device specifications This manual will explain the follow procedures required for setting up Reports for BDX 1) Downloading BDX Reports EAR and Script 2) Executing BDX database configuration script 3) Deploying the BDX Reports Application EAR into GlassFish 4) Adding Templates to Niagara 5) Setting up Templates in Niagara 6) Setting up Reports in BDX Note: If purchased along with a New XD Box, Reports for BDX comes setup and licensed. If setting up Reports on a new XD box, start at step 4. If installing Reports from scratch on a computer, virtual machine or old XD Box, start at step 1. 1) Downloading BDX Reports EAR and Script a) Download the BDX Reports Application zip file (BDXReports dist.zip) from the wiki BDX Reports Install and Setup Guide Rev. 3/2015 Page 1 of 17

2 b) Unzip the files to a folder Note: The zip file contains the BDX Reports Application and SQL scripts for each database type 2) Executing BDX database configuration script The existing BDX database needs to be configured to work with Report ScoreCards. A SQL script for each individual database type has been created to automate this process. This script creates objects (tables) in the database. For the following steps, refer to the Guide to SQL Databases. a) Start the database management program for the specific database type b) Select the BDX database c) Execute the BDXReports_Create.sql script d) Verify the script executed successfully 3) Deploying the BDX Reports Application EAR into GlassFish The BDX Reports EAR file needs to be deployed in the Application Server (GlassFish) a) Open a web browser b) In the address bar, enter the host address of the Application Server followed by port if running on the local machine if running on a remote machine c) Enter the following default User Name and Password and click Login User Name = admin Password = pa$$4admin d) In the left menu column, click Applications e) Click the Deploy button Rev. 3/2015 Page 2 of 17

3 f) Click the Browse button g) Navigate to and select the BDXReports.ear file h) Click OK *Note: The OK button will display Processing while the application is being deployed. This process may take some time. i) When completed, verify successful deployment *Note: If the database (connection pool) is not setup properly, or the BDXReports_Create.sql script has not been executed, the BDX Reports deployment will fail. Rev. 3/2015 Page 3 of 17

4 To upgrade BDX Applications 1) Undeploy the old EAR 2) Restart the Application Server Service 3) Deploy the new EAR j) Restart the Application Server Service Start > Control Panel > Administrative Tools > Services Right click Application Server Select Restart 4) Adding Templates to Niagara BDX Reports relies on Basix Templates in the Niagara station. Point data from these templates is recorded into the BDX database via the BDX server/agent relationship. a) Download the Basix Profiles module (blxbasix.jar) and BLX Core 2 module (blxcore2.jar) from the wiki *Note: Some browsers (internet explorer) may automatically change the file extension from.jar to.zip upon saving. If this happens, change the file extension back to.jar b) Install the modules (.jar files) to the modules folder of the target Niagara installation or platform using software manager or file transfer client and restart WorkPlace AX or the station. i.e. C:\Niagara\Niagara-3.X.XX\modules c) Log in to the target station d) Create a folder for the device points e) Discover the device points and place them into the device folder f) Open the palette for the blxbasix module g) Drag and drop the appropriate device template from the unitary folder of the blxbasix palette onto the device points folder *Note: Currently supported unitary devices are as follows Blower Coil, Fan Coil, Heat Pump, Light Commercial Roof Top, Unit Vent, VAV Rev. 3/2015 Page 4 of 17

5 h) Enter a name for the Template i) Double click on the template from the nav tree. The License Wizard will display. Follow the steps and enter the License Key supplied by. *Note: Basix Templates must be licensed before they can be used. Contact to obtain a license. or BLOGIX ( ) Save the station after successful licensing. Rev. 3/2015 Page 5 of 17

6 5) Setting up Templates in Niagara *Note: This guide explains first the general details about templates. See below for a step by step guide to setting up templates. Basix Templates are a set of pre-configured Niagara objects designed to make setting up common devices easy, fast and consistent. They contain a set of pre-defined points, settings and graphics in template form that allow the integrator to customize and select specific details according the device. Once set up, templates can be copied and pasted into similar device folders without the need to be re-configured. Templates use the information and the mapped points entered by the integrator to normalize, or make consistent, the point data into BDX. The integrator can individually select the point mappings or choose from a list of preconfigured point names according to common standards. Templates will always read from mapped points but can also be configured to write to writable points. Point and device information entered in the template is sent to BDX and used in Reports. *Note: Currently supported unitary devices are as follows Blower Coil, Fan Coil, Heat Pump, Light Commercial Roof Top, Unit Vent, VAV Below the template objects are all the points associated with the template. These points must be mapped using the Read Only Config and Write Only Config views. These points function and operate just like any other Niagara point and can be linked to/from, used in wiresheet logic and applied to graphics. The template object itself contains 7 views for various setup and functionality. Rev. 3/2015 Page 6 of 17

7 Template View: The main graphics view (not currently available on Blower Coil or Light RTU). These are the pre-configured graphics that come with the templates. The points on the graphics use the points from within the template object. These graphics are inserted into the station upon template creation and are stored in station:files:blx/px. They can be edited, removed or custom views can be used. Because graphics can be customized, they are not automatically upgraded or overwrote when the Basix jar is upgraded. To obtain the latest Basix graphics upon upgrade, first backup the old px files, remove the old BLX/px files folder and right click on a template type and select Actions > Re Initialize. Do this for each template type used in the station. This will automatically add the new px files from the JAR. Any custom changes to the graphics must be merged manually from the backup into the new ones if desired. A warning message in the template log view will notify if a new px graphic is available. Config Main Page: The main template config page. It contains all the settings and configuration options for the template. These options must be entered using the equipment specifications in order to function fully with BDX and Reports. This page also contains links at the top to the other views. Read Only Config: The mapping view for the templates read only points. This view is used to select or map the appropriate device point to the template point. This action of mapping is what normalizes the points to a consistent standard. Points are considered read only based on common point standards for the device. Write Only Config: The mapping view for the templates writeable points. This view is used to select or map the appropriate device point to the template point. This action of mapping is what normalizes the points to a consistent standard. Points are considered writable based on common point standards for the device. Template Enum Map: The mapping view for the templates enum point facets. Points can be mapped relatively easily, however, due to differences in devices and language, enum facets must be mapped with more integrator intervention. To match up the template point enum facets to the mapped point enum facets, the Template Enum Map page is used. Rev. 3/2015 Page 7 of 17

8 Write Only Status: The detailed view for all writable points and their mapped points along with current values and statuses. This view is used as a check or for verification that the writable points are mapped or being wrote to properly. Use this view to also resolve discrepancies if differences are seen between a template point and the mapped point. Basix Log View: The detailed log view containing warnings and messages relating to the template. This view will populate with messages when issues arise. Such messages include a new px file, incomplete point or enum mappings, point changes, missing information and general errors. When messages are present, a red View User Warnings button will be displayed on the main config page. Rev. 3/2015 Page 8 of 17

9 Template Setup a) Access the main config view for the template b) On the General Configuration tab, enter an Equipment Tag for the device An Equipment Tag is a name or blueprint tag for the device. *Note: A string point may be used (i.e. ObjectName) for the Equipment Tag. c) Select the Default Points Folder ord for the device *Note: Templates come in with the Default Points Folder set to the folder where the template resides. If necessary, change the default points folder to point to the device points folder. d) Click Save and Yes to confirm e) Click the Change Configuration button f) Select the standard point names list that matches the device configuration and click OK. If the standard points names list used for the device is not listed, select Custom. Note: Changing the template configuration and selecting from a drop down list of pre-set configurations simply populates standard point names on the READ ONLY and WRITE ONLY point mapping pages. This is designed to make integration quick and efficient by using standard names typically seen in the industry. If the specific device configuration is not listed or the device uses non-standard names, simply select Custom. Individual point names will not be populated and will need to be selected and manually mapped on the READ ONLY and WRITE ONLY point mapping pages. g) Enter a Device Location for the equipment A Device Location is the physical location of the equipment, i.e. Roof, Warehouse or Maintenance room Note: A string point may be used for the Device Location. h) Enter the Area Served by the device The Area Served is physical space the device controls, i.e. Room 123, Hallway or Office. Note: A string point may be used for the Area Served. i) In the Notes section, enter notes as needed. This is for informational purposes only. Note: The Show points that are not used by BDX and Show points used by PX graphic check boxes simply enable and disable the display of these points on the READ ONLY CONFIG and WRITE ONLY CONFIG views. If using templates for BDX Reports only, these check boxes can be unchecked for a cleaner interface. j) Click the Write to write only points check box to enable the template points to control the mapped points. Enable this if you are controlling the template points directly and want the values to be wrote to the writable mapped points. If using the templates to simply read and normalize points and do not want to control the mapped points, leave this box unchecked. If unchecked, all points will act as read-only. Note: Enabling writing to writable points will reveal a Write-only Point Set Level selection box. Select the level you want writable mapped points to be wrote to. The template point will write to the mapped writable point at that level. This setting is global for ALL writable points mapped in the template. Action Mirrored automatically writes to the writable mapped point using the same level the template point is controlled at. This is the default and recommended setting. In 1 thru In 16 and fallback coincide with the standard Niagara levels Action Set, Action Override and Action Emergency Override all mimic the Niagara actions on the point. Points are wrote to at their respective levels (set = fallback, override = In 8, emergency override = In 1) k) Click Save Rev. 3/2015 Page 9 of 17

10 l) Click the Device Configuration tab m) Enter the equipment configuration information. Obtain this information from the device specifications or user manual. Note: Device Configuration encompasses mechanical or physical information about the device n) Click Save Note: Complete and accurate information about the equipment is required in order to function properly and fully with BDX Reports. o) Click the IS Specifications tab p) Enter the equipment configuration information. Obtain this information from the device specifications or user manual. Note: IS Specifications encompasses technical or operational information about the device q) Click Save Note: Complete and accurate information about the equipment is required in order to function properly and fully with BDX Reports. Rev. 3/2015 Page 10 of 17

11 Note: Icons next to the fields reflect their usage r) Click the Read Only Config button to access the read only points config view s) Click the point selector icon. Navigate to and select the appropriate device point that corresponds to the selected template point. This selecting action maps the points. t) Click Save Note: If using a Custom configuration, point name fields will be blank. If using a specific configuration (i.e. LON) point name fields will be pre-populated with standard point names. Selected points must be of the same type as the template points (i.e. map numeric to numeric. An enum cannot be mapped to a boolean). Invalid point mappings will be highlighted in red. Valid point mappings will be gray. If a point does not exist or the mapping cannot be resolved, delete the name from the field. Point locations are relativized to the default points folder selected on the main config page. Points can exist in other folders or sub folders below the default points folder. Relative paths are maintained when templates are duplicated. Use the Show entire relative path to points check box to toggle between displaying just the point name and the entire point path relative to the default points folder. The default points folder is displayed on the page for verification. Rev. 3/2015 Page 11 of 17

12 u) Click the Write Only Config button to access the writeable points config view v) Click the point selector icon. Navigate to and select the appropriate device point that corresponds to the selected template point. This selecting action maps the points. w) Click Save Note: The mapping functionality is the same as the read only config. See above for more information. Note: The writable points config view has an addition line that shows the write setting and write level. x) Click Commit Configuration (if writing to write only points) to commit the settings and start the writing of template points to writable device points. *Note: If the commit configuration button is displayed, the template does not currently have control and the points are not being wrote to. *Note: The Commit Configuration button is not displayed when in read-only mode ( Write to write only points disabled). Functionality of template to device point writing and control To enable writing of template points to mapped writable device points, 4 items must be completed. 1. Write to write only points check box must be enabled 2. The write-only level must be chosen 3. The writable points must be mapped 4. The configuration must be committed (commit configuration button) With the writable device points being mapped and wrote to (committed) from the template, the template now assumes control over the points. The template is not aware of another control on the writeable point and assumes it has control. Be aware of this before controlling the point with some other logic. If the point is controlled by some other logic at a higher level than what the template writes to, the template will not have control and the template point value can be different than the device point value. Use the Write Only Status view to verify points are being written to properly or to resolve discrepancies if differences are seen between the template point and the mapped point. The write control on the point will be released (configuration becomes uncommitted) if any of the following happen. The point mapping is changed, the default point folder ord is changed, or the point write level status is changed. Rev. 3/2015 Page 12 of 17

13 y) Click the BDX Enum Mapping button to access the enum mapping view Note: BDX uses a pre-configured standard set of enum facets for Operation Mode, Occupancy Status and Occupancy Command. The device point mapped into these template points also has a set of enum facets. Due to differences in devices and language, these facets may not correspond, thus the facet values must be manually mapped as well. For this the enum mapping view is used. z) In the Point Selection (1 st ) box, select an enum point aa) In the BDX Mapping (3 rd ) box, view the list of BDX enum facets bb) In the Enum Values (2 nd ) box, view the list of the point s facets cc) In the BDX Mapping (3 rd ) box, in the Primary column, enter the enum value (number) from the 2 nd box that corresponds to the enum in the 3 rd box *Note: The BDX enum mapping (3 rd ) box requires a value for each field in the Primary column. If a point does not have an enum value that corresponds to a BDX enum, simply enter a generic value that the point will never be. (i.e. 901, 902, 903) *Note: If a point has multiple enum values that correspond to a single BDX enum, enter those additional values in the Optional and Optional 2 column. If a point has more than 3 enum values, use wiresheet logic to combine the values (EnumSelect block) *Note: If no enum values populate in the 2 nd box make sure a point is mapped on the read only or write only config pages and that it has enum facets configured. *Note: The template first looks at the enum facets for the mapped point. If none exist, it then looks at the facets for the template point (none by default). Whichever facets are found first will be populated in the enum values (2 nd ) box. If no facets are found, none are displayed. dd) Repeat this process for the other enum points listed in the Point Selection (1 st ) box ee) Click Save *Note: The Copy current mappings to other points check box allows you to copy one points enum mappings to another point. This is for convenience and time savings. Rev. 3/2015 Page 13 of 17

14 Template Actions Re Initialize = Resets the template without changing the settings and copies any needed PX files. Commit Write Only Config = Same action as clicking the Commit Configuration (write to points). Remap All Points = Re-reads and re-links mapped points. Use if template is set up before the point exist. Change Configuration = Same action as clicking the Change Configuration button. 6) Setting up Reports in BDX Report ScoreCards reside within the BDX server. Accessing and executing Report ScoreCards is done via the BDX interface. BDX is accessed by navigating a web browser to the bdx server. See the BDX Setup and Install Guide for more information. a) Access the BDX installation as a user with administrator privileges Rev. 3/2015 Page 14 of 17

15 b) Navigate to System > About BDX c) Verify BDX Reports is installed (if not, follow the Deploying instructions above) d) Navigate to System > Manage Licenses e) Verify the BDX installation is licensed for BDX Reports If the BDX installation is not licensed for BDX Reports, upload the.lic license file provided by with the BDX Reports license for the BDX installation. If you do not have a.lic file, contact to obtain a license. or BLOGIX ( ) *Note: BDX Reports is licensed by the number of devices. Please have the number of devices ready when ordering a license. Rev. 3/2015 Page 15 of 17

16 f) Navigate to Administration > Manage Agents g) Click the Edit Agent icon h) Click the Advanced tab i) Click the Refresh All Metadata button *Note: Refresh the metadata for each Agent which Templates were added j) Navigate to Administration > Manage Buildings k) Click the Edit Building icon Rev. 3/2015 Page 16 of 17

17 l) In the Select Points section, navigate to and select the device templates that belong to the building m) Click Add Points n) Click Subscribe to Data Points to subscribe to the templates o) Click Update The setup of Reports is now complete. Please refer to BDX Reports User Manual for information on how to use Reports. Rev. 3/2015 Page 17 of 17