Graphics
Graphics
Introduction
1 About This Guide ........................................................... 9
1.1 Purpose of This Guide ................................................................. 11
1.2 How This Guide is Organized ...................................................... 12
1.3 Typographical Conventions ......................................................... 13
Tutorial
3 Our Case Study ........................................................... 21
3.1 University X ................................................................................. 23
3.2 Requirements and Specifications ................................................ 26
3.2.1 Devices Used for This Case Study ............................................. 26
3.2.2 Software Used in This Tutorial ................................................... 26
3.2.3 Specifications ........................................................................... 26
3.3 Focus of This Tutorial .................................................................. 27
3.3.1 Pre-existing Database Folders and Programs ............................ 27
3.3.2 Pre-existing Database Objects .................................................. 30
Topics
Purpose of This Guide
How This Guide is Organized
Typographical Conventions
1 About This Guide
1.1 Purpose of This Guide
Introduction
The Introduction part contains information on the purpose of this guide, how this
guide is organized, where to find more information, and information on regulatory
notices.
Tutorial
The Tutorial part contains a step-by-step description of how to carry out different
tasks. If you want more information, see WebHelp or the corresponding Building
Operation Guide.
The Tutorial part includes a case study for a fictional customer called University X.
You can decide if you want to follow the example or use the described procedures
as reference information. The case study in this tutorial is an example of a typical
way of configuring Building Operation for a customer. When reading through this
tutorial, you might not have access to the devices, programs, and other files that
are needed for the fictional customer University X. However, the purpose of having
a case study is to see the procedures put in context, so you see how the
procedures could be used when configuring Building Operation, devices, or
programs for your customer.
Tip
Helps you understand the benefits and capabilities of the product.
Note
Provides you with supplementary information.
Important
Alerts you to supplementary information that is essential to the completion of a
task.
Caution
Alerts you to a condition that can cause loss of data.
Warning
Alerts you to a condition that can cause product damage or physical harm.
Bold texts:
User interface items, such as property names and buttons, are written in bold, for
example "On the File menu, select New."
Example texts:
All the example related information is indicated by blue lines and bullets.
Topics
Where to Find Additional Information
Regulatory Notices
2 Additional Information
2.1 Where to Find Additional Information
UL 916 Listed products for the Unites States and Canada, Open
Class Energy Management Equipment.
Industry Canada
ICES-003
This is a Class B digital device that meets all requirements of the Canadian
Interference Causing Equipment Regulations.
Topics
University X
Requirements and Specifications
Focus of This Tutorial
3 Our Case Study
3.1 University X
3.1 University X
We are going to install Building Operation as the building management system for
University X. The university is a campus of buildings for which heating and cooling
are supplied from a Central Plant with an underground distribution system. The
case study focuses on the renovation of the Central Plant and the expansion of the
School of Business.
3.2.3 Specifications
You find specifications in the Building Operation datasheets for Enterprise Server,
WorkStation, PS-24V Power Supply, Automation Server, and I/O Module Family.
Topics
Creating a Graphic
Importing a Components Category
Adjusting the Graphic Work Area
4 Creating a Graphic and Preparing the Editor
Our Example
The University X operators require graphics to make it easier to navigate, monitor,
and control the system.
In this chapter, you create graphics in WorkStation and then open the graphics for
editing. You also configure Graphics Editor to make creating the graphics efficient.
To create a graphic
1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the graphic. In this example, select ...University X
ES1/Servers/CPlant AS/Graphics.
2. On the File menu, point to New and then click Graphic.
3. In the Name box, type a name for the graphic. In this example, type
“Cooling Plant Graphic.”
4. In the Description box, type a description for the graphic. In this example,
type “Graphic for managing the Cooling Plant.”
5. Click Next.
6. Click Create.
For this example, repeat the procedure to create the following graphic objects:
Table: Graphics
Floor Plan Graphic ...University X Plan graphic for floor Floor Plan.tgml
ES1/Servers/CPlant one
AS/Graphics
For this example, repeat the procedure to import the Heating Plant and Cooling
Plant component categories by using the following files:
• Cooling Plant.tgmlcomponentArchive
• Heating Plant.tgmlcomponentArchive
5. In the Stretch box, select the the behavior of the graphic when displayed in
WorkStation. In this example, select Uniform.
6. In the Height box, type the value for the height of the work area. In this
example, type “768.”
Continued on next page
7. In the Width box, type the value for the width of the work area. In this
example, type “1024.”
For this example, repeat the procedure to adjust the work area for the Home Page
graphic.
• Location: ...University X ES1/Graphics/Home Page Graphic
• Background: white (#FFFFF)
• Stretch: Uniform
• Height: 768
• Width: 1024
Topics
Adding a Layer
Inserting a Picture
Adding a Component
Adding Text Using the Text Tool
Adding Text Using the Textbox tool
Drawing a Rectangle
5 Using the Basic Editor Tools to Design a Graphic
Our Example
In this chapter, you use layers to maximize engineering efficiency. You also insert
pictures, use pre-existing components, add text, and use drawing tools.
To add a layer
1. In Graphics Editor, on the View menu, click Layers.
2. In the Layers pane, on the Layers toolbar, click the New Layer button .
3. In the layer list, double click the layer name and type the name of the layer.
In this example, type “Background Layer.”
4. Press Enter.
5. On the File menu, click Save.
For this example, repeat the procedure to create the Top Layer layer.
To insert a picture
1. In Graphics Editor, in the Layers pane, select the layer where you want to add
the picture. In this example, select Background Layer.
2. On the Drawing toolbar, click Insert Picture.
3. In the work area, click where you want to locate the upper-left corner of the
picture.
4. Select the picture you want to insert into the graphic. In this example,
select ...Project University X\Images\University - X Logo White
Background.png.
5. On the Drawing toolbar, click Select.
6. On the Options toolbar or in the Properties pane, adjust the appearance of
the picture. In this example, use the following picture properties: Left: 818,
Top: 710, Height: 41, and Width: 182.
7. On the File menu, click Save.
For this example, repeat the procedure to add the Cooling Plant Background.png
to the Background Layer. Use the following picture settings:
• Location: ...Project University X\Images\Cooling Plant Background.png
• Left: 7
• Top: 180
To add a component
1. In Graphics Editor, in the Layers pane, select the layer where you want to add
the component. In this example, select Top Layer.
2. In the Components pane, click the component category tab that contains
the component you want to use. In this example, click Cooling Plant.
3. Select the component you want to add. In this example, select
CoolingTowerFor_gifs.
5. In the Properties pane, in the Name box, type the name of the component.
In this example, type “Cooling Tower.”
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
For this example, repeat the procedure to add the following components to the
Cooling Plant graphic:
Continued
Component Name Name Property Left Top
DP CdwPStatus 49 346
DP ChwPStatus 39 513
5. Press Enter.
6. On the Drawing toolbar, click Select.
For this example, repeat the procedures to add the following text labels on the
Cooling Plant graphic. Use the following text properties, Stroke: Black (#000000),
FontFamily: Arial, and FontSize: 15 px.
Primary 30 611
Continued
Text Left Top
For this example, repeat the procedures to add the following wrapped text labels.
Use the following text properties: Stroke: Black, FontFamily: Arial, FontSize:
15, and HorizontalAlign: Center.
• Secondary Pumps
– Left: 502
– Top: 221
– Height: 39
– Width: 106
• AHU Chilled Water Coils
– Left: 665
– Top: 155
– Height: 42
– Width: 127
To draw a rectangle
1. In Graphics Editor, in the Layers pane, select the layer you want to draw the
rectangle on. In this example, select Top Layer.
2. On the Drawing toolbar, click Rectangle.
3. In the work area, click where you want the rectangle to begin and drag the
pointer to where you want it to end. In this example, click the white space at
the bottom of the work area.
Topics
Adding a Snippet
Grouping Drawing Objects as a Component
Saving as a Component
Making Text Content Dynamic
Adding an Animated Picture
Making an Animated Picture Dynamic
Testing a Graphic in Preview Mode
Saving as a Snippet
Adding a Link
6 Creating and Saving Components and Snippets
Our Example
In this chapter, you use pre-existing snippets to control the animation in your
graphic. You also create a custom component and add dynamic text and links to
the graphic.
To add a Snippet
1. In Graphics Editor, in the Layers pane, select the layer where you want to add
the snippet. In this example, select Top Layer.
2. In the Snippet pane, select the snippet category tab that contains the snippet
you want to use. In this example, select Basic Functions.
3. Select the snippet you want to add to the graphic. In this example, select
DynamicValueAndUnit.
4. Drag the snippet to the work area or to a drawing object. In this example,
drag the snippet to the work area and then drag it on top of the data field
rectangle.
5. On the Drawing toolbar, click Select.
Continued on next page
To save as a component
1. In Graphics Editor, on the work area, select the component you want to save
to highlight it in the Objects pane. In this example, select the data field
component.
2. From the Objects pane, drag the component to the components category
that you want to add the component to. In this example, drag to My
Components.
Important
You have to drag the component from the Objects pane. You can
not drag the component from the work area.
3. In the Properties dialog box, in the Name box, type the name you want to
display in the components category. In this example, type “Numeric
Display.”
4. In the Description box, type the description you want to display as the
tooltip in the components category. In this example, type “Displays numeric
presentation with data field.”
5. In the Height box, type the height you want the component to have when it is
added to the work area. In this example, type “20.”
6. In the Width box, type the width you want the component to have when it is
added to the work area. In this example, type “60.”
7. Click OK.
The component is now saved in the Components library for use in the current
graphic and future graphics.
For this example, use the newly created Numeric Display component for adding the
following components to the Cooling Plant graphic. Use the Properties pane to add
the following values:
ChwrTempRV 68 441
CdwsTempCV 28 314
TwrExitTempRV 14 219
Continued
Name Left Top
4. In the Properties pane, in the Name box, type the name of the Bind object.
In this example, type “Value.”
6. In the Objects pane, right-click Bind, point to New, and then click
ConvertValue.
7. In the Properties pane, in the Name box, type a name for the ConvertValue
object. In this example, type “Enabled.”
8. In the AttributeValue box, type the text that you want to display in the
graphic. In this example, type “Enabled.”
Continued on next page
9. In the SignalEqualTo box, type the value when the text is to be displayed.
In this example, type “1.”
10. Add more ConvertValue objects to the Bind object, one for each value of the
variable that is to be displayed as text. In this example, create one more
ConvertValue object using the following properties: Name: Off,
AttributeValue: Off, and SignalEqualTo: 0.
11. In the Objects pane, right-click the Text, point to Group as, and then click
Component.
12. In the Properties pane, in the Name box, type the name of the component.
In this example, type “ChwPStatus.”
For this example, repeat the procedure to make the texts (“Dynamic Text”) for the
secondary chilled water pumps dynamic.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
For this example, repeat the procedure to add an animated picture for Cooling
Tower Fan 2. Use the following settings:
• File: ...Project University X\Images\Cooling-Tower.gif
• Name: TwrFan2Cmd
• Left: 195
• Top: 141
10. In the Objects pane, right-click Bind, point to New, and then click Convert
Value.
11. In the Properties pane, in the Name box, type the name of the
ConvertValue. In this example, type “Stop.”
12. In the AttributeValue box, select Stop.
13. In the SignalEqualTo box, type the value that should stop the animation.
In this example, type “0.”
14. On the File menu, click Save.
To save as a snippet
1. In Graphics Editor, in the Objects Pane, select the Bind object that you want
to save to the Snippets library. In this example, select
TwrFan1Cmd.Value.
2. Drag the Bind object to the snippet category that you want to add the snippet
to. In this example, drag to My Snippets.
3. In the Properties dialog box, in the Name box, type the name you want to
display in the snippets category. In this example, type “Animation Start
Stop.”
4. In the Description box, type the description that you want to display as the
ToolTip in the Snippets category. In this example, type “Starts and stops
animation based on a digital value.”
5. Click Ok.
The snippet is now saved in the Snippets library for use in the current graphic and
future graphics.
For this example, use the newly created Animation Start Stop snippet to make the
Cooling Tower Fan 2 picture animation start and stop, by adding the snippet to the
animated image TwrFan2Cmd. Use the Properties pane to change the Bind
Name: TwrFan2Cmd.Value.
To add a link
1. In Graphics Editor, click the Snippets tab.
2. Select the Basic Functions category.
3. Drag the Link snippet to the drawing object that will be linked to a Web site,
application, or document. In this example, drag the Link snippet to the
Logs button.
4. In the Objects pane, click the Link object.
5. In the Properties pane, in the LinkName box, type the name of the Link
object. In this example, type “Folder.”
6. Click Save.
The link is now added to the graphic and is available for binding in WorkStation.
Topics
Importing a Solution
Binding Values Using a Binding Template
Creating a Panel
Summary
7 Working with Graphics in WorkStation
Our Example
In this chapter, you work with graphics in WorkStation to edit the bindings to the
graphics so that live data is displayed. You also bind the links of the graphic to
make navigation possible. For engineering efficiency, you import a custom binding
template that you use to create all the bindings. Finally, you save engineering time
by adding the banner graphic to a panel to make it work for all the graphics.
To import a solution
1. In WorkStation, in the System Tree pane or List View, select a location
where you want to import a solution. In this example, select ...University
X ES1/System/Binding Templates.
2. On the File menu, click Import.
3. In the Open dialog box, select the file and click Open. In this example,
select University X Graphics Binding Template.xml.
4. In the Import dialog box, resolve any name conflicts listed under Name
conflicts. In this example, there should not be any name conflicts.
5. Click Import.
Tip
• When creating bindings, follow the recommended general guidelines: create
bindings between Inputs and Outputs only and do not create bindings to
Public Signals.
3. In the binding point browser, drag the object or folder to the binding template
that you want to apply. In this example, drag ...University X
ES1/Servers/CPlant AS to the Graphics Binding Template.
4. Select the bindings that you want to create. In this example, keep all
bindings selected.
5. Click OK.
Continued on next page
6. Verify that all bindings are correctly bound. In this example, verify the
bindings against the table below.
Tip
• To ensure data flow is occurring as intended, use the Watch pane to view
values and monitor changes.
For this example, repeat the procedure to create the remaining bindings for the
Cooling Plant graphic and all the bindings for the following graphics:
Cooling Plant Graphic
Create the remaining bindings for ...University X ES1/Servers/CPlant
AS/Graphics/Cooling Plant Graphic:
• Drag ...University X ES1/Graphics to the Graphics Binding Template.
• Drag ...University X ES1/Central Plant Bldg to the Graphics Binding
Template.
• Drag ...University X ES1/Application to the Graphics Binding
Template.
Continued
Binding Point Binding
Banner Graphic
Create the bindings for ...University X ES1/Application/Panels/Banner
Graphic:
• Drag ...University X ES1/Servers/CPlant AS to the Graphics Binding
Template.
To create a panel
1. In WorkStation, in the System Tree pane, select in the folder where you want
to create the panel. In this example, select ...University X
ES1/Application/Panels.
2. On the File menu, click New, and then Panel.
3. In the Name box, type a name for the panel. In this example, type “Main
Panel.”
4. In the Description box, type a description for the panel. In this example,
type “Panel used to display University X header in HVAC Operator
Workspace.”
5. Click Next.
Continued on next page
6. Click Add to add an object to the panel. In this example, you add an object
to the panel.
7. In the object type list, select the type of panel component you want to add.
In this example, select Graphic Pane.
8. In the Name box, type a name for the component. In this example, type
“Banner.”
9. In the Description box, type a description for the panel component. In this
example, type “University X banner for all graphics.”
Continued on next page
15. In the Show toolbars box, select Yes to display the toolbar for the object
listed in the initial path. In this example, select No.
7.4 Summary
You have now created a graphic for monitoring and controlling the Cooling
Plant. This graphic was created using components, snippets, animated .gifs, text
boxes, and dynamic text. You also created bindings and links in WorkStation so
that live data is displayed and navigation to other graphics is easier.
It is now possible to see the cooling tower fans spinning when they are running, and
view the temperatures and statuses of the cooling plant system. Additionally, you
can click on the links to open other graphics, trend charts, and trend logs.
Additionally, you associated pre-existing .tgml files to the Floor Plan, Home Page,
and main panel graphics and created a panel to reuse the banner graphic for all the
graphics.
04-14027-01-en
July 2013