System navigation. generated from the 2.0 help files. Copyright 2003 System navigation Page 1

Transcription

1 System navigation generated from the 2.0 help files Copyright 2003 System navigation Page 1

2 .pdf created on 4/7/03 WebCTRL v2.0 Copyright 2003 Automated Logic Corporation. All rights reserved Roberts Boulevard, Kennesaw, GA Phone (770) FAX (770) Visit us at www. automatedlogic. com Automated Logic, the Automated Logic logo, Eikon, InterOp, and WebCTRL are registered trademarks of Automated Logic Corporation. BACnet is a registered trademark of ASHRAE. FrontPage is a registered trademark of Microsoft. All other brand and product names are trademarked by their respective owners. Copyright 2003 System navigation Page 2

3 System navigation 4 Action pane 6 Navigation pane 7 Navigation trees and view buttons 8 Action buttons 9 Action buttons, categories, and items 9 Default categories 11 To add a category 12 Display tabs 14 Back button 15 Tree ornaments 16 Tree ornaments for schedule categories 18 Tree ornaments for event categories 20 System-wide Events button 22 Displaying help 23 Menu commands 24 Errors in WebCTRL 26 Colors in WebCTRL 27 Color Chart 27 Calendar pop-ups 28 Copyright 2003 System navigation Page 3

4 System navigation Navigation includes the various features in WebCTRL that allow you to move through the system or perform functions when accessing WebCTRL through a browser such as Internet Explorer. Use only the WebCTRL interface to navigate through WebCTRL; do not use the browser s buttons. We recommend that you disable your browser s buttons and address bar. NOTE For information on navigating WebCTRL on a WAP-enabled device, refer to Wireless Device Support in WebCTRL in the Using mini browsers manual. WebCTRL provides many ways to navigate the system and view information. Click each item in the list below to see a description of the item and how it is used. Copyright 2003 System navigation Page 4

5 1 Action pane 2 Navigation pane 3 Navigation trees and view buttons 4 Action buttons 5 Categories and items 6 Display tabs 7 Back button 8 Tree ornaments button 9 System-wide Events button 10 Show/Hide button 11 Help button 12 Menu button When you log in to WebCTRL, the opening screen depends on your start location defined on the Operators page. For example, you may see the graphic for the first floor, while another operator may see the Properties page for a piece of equipment. See To configure an operator in the Operator security manual. Copyright 2003 System navigation Page 5

6 Action pane The action pane is where you view information and perform actions in WebCTRL. The information displayed in the action is based on your selection for the: 1 view button 2 item in the navigation tree 3 action button 4 category and/or item 5 display tab Copyright 2003 System navigation Page 6

7 Navigation pane 1 The navigation pane consists of the tree ornaments menu, the navigation tree, and the view buttons. 2 You can have the navigation pane visible at all times, 3 or you can click the show/hide button 4 to hide the navigation pane until you need it. NOTE When you log out, WebCTRL remembers your configuration of the navigation pane. When you log in again, WebCTRL shows the same configuration. 5 Move the cursor across the left edge of the action pane to bring a hidden navigation pane into view. When you move the cursor off the navigation pane, it will hide again. 6 Click and drag the right edge of the navigation pane to adjust its width. Copyright 2003 System navigation Page 7

8 Navigation trees and view buttons Use the navigation tree to select the item that you want to see in the action pane. The four view buttons, located at the bottom of the navigation pane, let you select which navigation tree you want to see. NOTE If you do not see one of the buttons, you do not have the privilege to see or use that tree. Click this button... to view the... Geographic tree: the hierarchy of areas and equipment defined in SiteBuilder. Network tree: a network-oriented view of your system. This generally shows the BACnet network. The only non-bacnet items in the Network tree are equipment items. Groups tree: non-hierarchical groups, such as schedule groups. Configuration tree: run-time system options you must configure and other WebCTRL functions such as Event Simulator and Download. Copyright 2003 System navigation Page 8

9 Action buttons The following conditions determine which action buttons you see above the action pane: the version of WebCTRL you are running (WebCTRL Express, Standard, or Pro) the privileges assigned to you the view button you click in the navigation pane the item you select in the navigation tree The following table describes what each action button displays for the selected item in the navigation tree. Click this button... to view... a graphic. all of the control values that may be read from or written to the item. pages where you view or configure schedules. a page where you assign reporting actions to event categories and another page where you view and respond to events that have occurred. pages where you can view or configure trends. the control program logic (or GFB) used to control a piece of equipment. the Checkout Report, Point List Report, Network Status Report, Module Version Report, Security Report and any custom reports. a page where you assign privilege sets to operators at specific locations in the system. This button is only visible if location-dependent security is enabled on the System Settings page. Action buttons, categories, and items If an action button has a drop-down arrow, you can click the arrow to display a menu of categories or items. When you click one of these, the information shown in the action pane is limited to your selection. Copyright 2003 System navigation Page 9

10 In WebCTRL, categories are groups of similar items. For example, all graphics that pertain to lighting could be assigned to a Graphics Lighting category. You can define categories for Graphics, Schedules, Events, Properties, Trends, and Reports. For Graphics, Trends and Reports categories, you can have multiple items in a category. 1 An action button with a drop-down arrow has multiple categories and/or multiple items for the selected location on the navigation tree. NOTE If the Graphics, Events, Trends, or Reports button does not have a drop-down arrow, there is only one category or item for the location. 2 Clicking the drop-down arrow displays a menu of categories, items, or both for that button. The example above shows a Maintenance category plus three items below the line (HVAC, Lighting and Thermographic) that are not assigned to a category. 3 If a category has a right arrow, clicking the category displays a sub-menu of all items in the category. Clicking one of the items filters the information shown in the action pane to that item. For example, clicking Maintenance displays a menu of all graphics in that category. Clicking Fire displays that graphic. NOTE Holding the cursor over an action button without clicking displays a tip that shows what will be displayed if you click the button. 4 Two arrows appear at the bottom of the category list when it becomes too lengthy. Click the down arrow to display more categories. 5 Click the up arrow to return to the previous list. Copyright 2003 System navigation Page 10

11 Default categories WebCTRL has the following default categories: Type of Category Definition Default Categories Graphics Categories allow multiple graphics for one area or equipment Unspecified, HVAC, Maintenance Properties Categories allow custom wireless device Properties pages to be Unspecified associated with each area or group Trend Categories allow multiple trends for one area or equipment Unspecified, Inactive, Custom, Input, Output, Calculated Report Categories allow multiple reports to be assigned for one area or group Unspecified, Maintenance, Security NOTE To see Maintenance categories, you must have the check box View Installation and Maintenance Tools enabled on the Operators page. Copyright 2003 System navigation Page 11

12 To add a category Copyright 2003 System navigation Page 12

13 1 Clicking CFG, the plus (+) sign to the left of Categories, then the type of category you want to configure. 2 Click Add. NOTE You can edit an existing category by highlighting the category in the Select Category table. 3 Complete the following fields: Reference Name Enter a name similar to the Category Name. The Reference Name cannot contain any spaces, must be lower case, and must be unique because it is used in the database to specifically identify this category. Category Name Enter the new name of the category to appear in WebCTRL. Privilege Click the drop-down arrow to then click a privilege. An operator with this privilege will be able to view this category. Use as maintenance tool Enable this check box to configure the category as a maintenance tool. NOTE For an operator to be able to view categories defined as maintenance tools, the View Installation and Maintenance Tools field must be enabled on the Operators page. An administrator can click CFG-Operators to select this preference for an operator. 4 Click Accept. Copyright 2003 System navigation Page 13

14 Display tabs 1 When you click a Properties, Schedules, Events, Trends, or Reports action button, display tabs appear at the top of the action pane. The different action buttons produce various display tabs. For example, when you click the drop-down arrow on the Reports button, and then click Maintenance and Point List Report, the display tabs are Configure and View. Clicking Configure displays the page where you define the information to be included in the report. View displays the report. 2 To the right of the display tabs, WebCTRL shows the item you selected in the navigation tree, plus the category and/or item. When you click a new item in the navigation tree, WebCTRL retains as many view characteristics (button/category/item/display tab) as possible for the new item. Copyright 2003 System navigation Page 14

15 Back button Click the Back button, located to the left of the action buttons, to return to the most recently viewed page. You can click this button up to nine times. NOTE Do not use your browser s navigation buttons to move through WebCTRL. Copyright 2003 System navigation Page 15

16 Tree ornaments Tree ornaments are highlights or icons that can be displayed in the navigation tree to indicate all equipment and areas that have one of the following conditions: schedules assigned to any of the schedule categories schedules assigned to a specific schedule category events assigned to any of the event categories events assigned to a specific event category The example at the right shows tree ornaments for all schedule categories. Copyright 2003 System navigation Page 16

17 To display tree ornaments: 1 Click the tree ornaments button. 2 Click Schedule Categories or Event Categories. In the example to the right, Event Categories has been clicked. 3 Click All Event (or Schedule) Categories to display tree ornaments for all event or schedule categories. or 4 Click a specific category to display tree ornaments for that category. WebCTRL displays different tree ornaments in the navigation tree, depending on what you choose in the tree ornaments menu. Related Topics: Tree ornaments for schedule categories on page 18 Tree ornaments for event categories on page 20 Copyright 2003 System navigation Page 17

18 Tree ornaments for schedule categories Tree ornaments for schedule categories indicate all equipment and areas that have schedules assigned to schedule categories. You can choose to display ornaments for all schedule categories or for a specific schedule category. For instructions on displaying tree ornaments, see Tree ornaments on page 16. This tree ornament... Blue text with icon Blue text, no icon indicates... that a schedule has been entered at this level and its category matches the schedule category that is currently selected in the tree ornaments menu. a schedule microblock that has been assigned to the schedule category that is currently selected in the tree ornaments menu. This microblock would be affected by any matching schedule entered above it in the navigation tree hierarchy. Copyright 2003 System navigation Page 18

19 Example: To see any areas or equipment definitions affected by occupancy schedules, we selected Schedule Categories > Occupancy from the tree ornament dropdown menu. In the navigation tree at the right, Atlanta-R&D Facility is highlighted in blue with a clock icon to indicate there is a schedule in the Occupancy category entered for Atlanta-R&D Facility. Schedules for other schedule categories may exist at this level, but we only selected the Occupancy category. The Schedule microblock in the Break Room is highlighted in blue because it is affected by the Occupancy schedule entered hierarchically above it for the Atlanta-R&D Facility. However, there is no clock icon because a schedule was not entered at this point in the building hierarchy. Copyright 2003 System navigation Page 19

20 Tree ornaments for event categories WebCTRL allows you to display tree ornaments in the navigation tree to indicate all equipment and areas that have events assigned to event categories. You can choose to display them for all event categories or for a specific event category. For instructions on displaying tree ornaments, see Tree ornaments on page 16. This tree ornament... Blue text with reporting action icon Blue text, no con indicates... that a reporting action has been assigned at this level and the reporting action is associated with an event category that is currently selected in the tree ornaments menu. that the BACnet object will generate an event of the event category currently selected in the tree ornaments menu. Copyright 2003 System navigation Page 20

21 Example: To see objects in the system that generate HVAC Critical events, we selected Event Categories > HVAC Critical from the tree ornament drop-down menu. The blue highlights in the navigation tree show that the Break Room Zone Temp and Discharge Temp objects can generate HVAC Critical events. The First Floor is highlighted blue with icons to indicate that the reporting actions for the HVAC Critical events are assigned at the First Floor. Copyright 2003 System navigation Page 21

22 System-wide Events button Click the System-wide Events button to display events for the entire system. Note that the highlight in the navigation tree jumps to the system level. A green button indicates that there are no events in the system that need acknowledging. A yellow button indicates that at least one non-critical event in the system needs acknowledging. A red button indicates that at least one critical event in the system needs acknowledging. Copyright 2003 System navigation Page 22

23 Displaying help WebCTRL gives you two ways to obtain help. 1 Click the Help button to display a help topic relevant to your current location in WebCTRL. or 2 Click the WebCTRL menu button, then the Help menu command to display the help files, beginning with What s New in the current version of WebCTRL. Copyright 2003 System navigation Page 23

24 Menu commands 1 Clicking the menu button opens 2 a drop-down menu of the system functions described below. Menu command Silence Description Temporarily silences for a 5-minute period an audible alert triggered by an event. This silences the alert only for the event that caused it. If a new event that triggers an alert is received during the 5-minute period, another alert will sound. NOTE The Silence menu command is only visible if the operator is receiving an audible alert. See To configure an operator in the Operator security manual. Print Opens the Print dialog box. We recommend that you set the print orientation to Landscape. When you click OK on the dialog, WebCTRL prints the contents of the action pane. The path to the current tree item automatically prints as the page header. NOTE The Print command removes the black background of floorplans and equipment graphics. Command Add Report Add Graph Opens a dialog box where you can execute any of the supported manual commands. See Manual commands. Opens a dialog box where you create a custom report for the selected tree item by choosing a report template created in Report Designer.See To add a report instance to an item in the navigation tree. Opens a dialog box where you create custom trend graphs. See to configure graphs in the Trends manual. Copyright 2003 System navigation Page 24

25 Menu command Delete Errors Help About Logout Description Deletes the custom report or custom trend graph that is currently displayed in the action pane. Reopens the Error dialog box, allowing you to reread an error message. You can use the View Debug Info link in the error window to describe problems to Technical Support. See Errors in WebCTRL on page 26. Opens the WebCTRL help file at a topic relevant to your current location. Opens a pop-up window that contains information about your WebCTRL software. Immediately logs out the current operator of WebCTRL. Copyright 2003 System navigation Page 25

26 Errors in WebCTRL 1 If you are running WebCTRL in normal mode and a page contains an error, a small red triangle appears in the lower right corner to signify that there is an error. Click on the triangle to display the Error dialog box. 2 The Error dialog box lists any errors on the current page. You can use the View Debug Info link to describe problems to Technical Support. NOTE You can also display the Error dialog box using the Errors menu command. See Menu commands on page 24. Copyright 2003 System navigation Page 26

27 Colors and status in WebCTRL WebCTRL s graphics use thermographic colors to show the current conditions throughout your system. The color bar shown below appears on many graphics as a reminder of color definitions. Color Chart Color Color Name Status Code Condition Indicated Mustard none In equipment - viewing in design server mode Purple 0 or 15 In a device - non-operational or no communications In equipment - a hardware or software error Charcoal 14 In a device - a download is required or is already in progress In equipment - a module has stopped Coral 13 FB error in the equipment Red 2 or 9 Heating or cooling alarm in the equipment Orange 8 2nd stage cool - much too warm Dark blue 3 2nd stage heat - much too cool Yellow 7 1st stage cool - too warm Light blue 4 1st stage heat - too cool Gray 1 Unoccupied/inactive White 10 Occupied/active Light green 6 Free cooling band Green 5 In a device - operational or operational read only In equipment - comfortable Copyright 2003 System navigation Page 27

28 Calendar pop-ups You can type dates in a date field or click the icon next to it to display a calendar where you select dates. Click a date (or week) to select it. A selected date turns red; a selected week turns blue. Copyright 2003 What s new in v2.0 Page 28

29 A About menu command 24 action buttons 4, 9 action pane 4, 6 Add Graph menu command 24 Add Report menu command 24 audible alerts 24 B Back button 4, 15 BACnet network 8 C calendar pop-ups 28 categories 4 adding 9 default 9 CFG button 8 colors in WebCTRL 27 Configuration tree 8 critical events 22 custom reports 24 custom trend graphs 24 D Delete menu command 24 display tabs 4, 14 E errors 26 Errors menu command 24 event categories tree ornaments 16, 20 events critical 22 non-critical 22 System-wide Events button 22 Events button 9 G GEO button 8 Copyright 2003 System navigation Page 29

30 Geographic tree 8 Graphics button 9 Groups tree 8 GRP button 8 H help 23 Help button 4 Help menu command 24 I items 4, 9 L logging out 24 Logic button 9 Logout menu command 24 M maintenance tool 9 manual commands 24 Menu button 4 menu commands 24 N navigation 4 navigation pane 4, 7 sizing 7 navigation trees 4, 7, 8 NET button 8 Network tree 8 non-critical events 22 P pop-ups calendar 28 Print menu command 24 printing 24 Privileges button, categories 9 Properties button 9 R reports Copyright 2003 System navigation Page 30

31 custom 24 Reports button 9 S schedule categories tree ornaments 16, 18 Schedules button 9 Show/Hide button 4, 7 Silence menu command 24 System-wide Events button 4, 22 T tree ornaments 4, 7, 16, 18, 20 event categories 16, 20 schedule categories 16, 18 trend graphs custom 24 Trends button 9 V view buttons 4, 7, 8 Copyright 2003 System navigation Page 31