Advanced Graphics Application Help

Вид документа	Керівництво користувача
Виробник	JCI
Код документа	advanced-graphics-application-help
Група обладнання	Advanced Graphics Application
Сторінок	57
Мова документа	англійська
Розмір файлу	1.8 МБ

Текст документа

Advanced Graphics Application Help
MS-ADVGRF-0 Code No. LIT-1201850
Software Release 9.0
Issued August 2017

Introduction................................................................................................................................2
Summary of Changes................................................................................................................2
Advanced Graphics Application Overview..............................................................................2
Scalable Vector Graphics (SVG)........................................................................................................2
Professional or Standard Edition of Microsoft Visio Software.......................................................2
Advanced Graphics Generation Application....................................................................................2
Menus...................................................................................................................................................3
Toolbar..................................................................................................................................................4
Preferences...........................................................................................................................................4
Precache Feature.................................................................................................................................5
Action Codes.........................................................................................................................................5
User Actions..........................................................................................................................................5
Dynamic Features.................................................................................................................................6
Expression Builder.............................................................................................................................7
Expression Syntax................................................................................................................................7
Logic Functions.....................................................................................................................................8
AGA Binder........................................................................................................................................10
Graphics Example Stencil................................................................................................................11
Binding and Aliasing........................................................................................................................14
User Graphics Tool...........................................................................................................................17
Advanced Graphics Viewing............................................................................................................17
Workflow............................................................................................................................................17
Advanced Graphics Steps......................................................................................................19
Creating and Editing an Advanced Graphic (Overview)...............................................................19
Configuring Graphics Example Shapes..............................................................................................19
Working with the Precache Definition.................................................................................................21
Adding Action Codes to a Shape........................................................................................................21
Configuring Action Codes...................................................................................................................22
Configuring Action Codes for a Return Fan Shape Example..............................................................42
Inserting an Advanced Graphic to the UGT...................................................................................47
Viewing a Graphic.............................................................................................................................48
Troubleshooting.......................................................................................................................49
Related Documentation...........................................................................................................53
Index..........................................................................................................................................55

Advanced Graphics Application Help 1
Introduction
Welcome to the Advanced Graphics Application Help.
This Help system describes how to configure and use the Advanced Graphics Application (AGA) to create system
graphics for the Metasys system. This Help system assumes the user has knowledge of Scalable Vector Graphics
(SVG) and how to use the User Graphics Tool (UGT) and the Professional or Standard edition of Microsoft® Visio®
2003, 2007, or 2010 software (32-bit versions only). The Advanced Graphics Application is not supported for use
with either Microsoft Visio 2013 or Visio for Office 365.

Summary of Changes
No changes were made to this documents at Release 9.0.

Advanced Graphics Application Overview
The Advanced Graphics Application is an enhanced graphics creation package that provides dynamic graphic
capabilities such as animation, color changing, and flashing for the Metasys system. The package includes a dynamic
example stencil library that is an add-on to the Professional or Standard edition of Microsoft Visio 2003, 2007, or
2010 software.
When you create an advanced graphic using the Graphics Example stencil, the graphic is bound to system data
through the System Configuration Tool (SCT) database. After the graphic file is saved, it is inserted as a Graphic
object into the Metasys system navigation tree.
Advanced graphics are viewed from the Metasys system Site Management Portal (SMP) UI framework. With a more
comprehensive representation of facility support systems, building operators can easily monitor the health of the
system on a more intuitive interface.

Scalable Vector Graphics (SVG)
The SVG file format is an XML-based web standard and is viewable and editable in any text editor, much like HTML
documents. The World Wide Web Consortium (www.w3.org) maintains the SVG specification. The Advanced Graphics
Application complies with the SVG specification for dynamic SVG graphics. Besides the ability to save SVG files,
the Advanced Graphics Application can also save a Zipped Scalable Vector Graphic (SVGZ) file, which is a
compressed SVG file.

Professional or Standard Edition of Microsoft Visio Software
The Advanced Graphics Application is designed to work with the Professional or Standard edition of Microsoft Visio
2003, 2007, or 2010 software (32-bit versions only), which refers to symbols as shapes. Visio drawings use the Visio
Drawing (VSD) file format. The Professional or Standard edition of Microsoft Visio 2003, 2007, or 2010 software
includes a stencil sheet mechanism that allows you to create stencil libraries. The Advanced Graphics Application
includes the Graphics Example stencil, a library of dynamic HVAC components.

Important: The Advanced Graphics Application is not supported for use with either Microsoft Visio 2013 or Visio
for Office 365.

Advanced Graphics Generation Application
The Advanced Graphics Application is an add-on graphics generation program used to create animated graphics
in the Professional or Standard edition of Microsoft Visio 2003, 2007, or 2010 software. Access the Advanced
Graphics Application by selecting Tools > Add-Ons > AGAActionCodeAddOn in the Professional or Standard
edition of Microsoft Visio 2003, 2007, or 2010 software. This add-on application allows you to configure the dynamic
capabilities for graphics using Action Codes (User Actions and Dynamic Features), the Expression Builder, and the
AGA Binder. See Figure 1.

Advanced Graphics Application Help 2
The Advanced Graphics Add-On screen consists of three distinct sections: A, B, and C (Figure 1). Use Section A
to select the user actions and dynamic features you want to define. After you make these choices, use Section B to
select which of the checked actions or dynamic features you want to work with. When you make your selections,
Section C reveals any required parameters for that action or dynamic feature. For example, Figure 1 shows the
parameters for the Left Click action code. For details on this process, see Adding Action Codes to a Shape.
Figure 1: Advanced Graphics Add-On Screen

Table 1: Advanced Graphics Screen Callouts
Callout Name
1 Menus
2 Toolbar
3 List of Selected Action Codes
4 User Actions
5 Dynamic Features

Note: To keep the Advanced Graphics Add-On screen always open while defining user actions and dynamic
features, right-click a blank spot on the graphic away from the Add-On screen. Then, if you are using Visio
2003, select View > Custom Properties Window. The Custom Properties Window appears. If you are using
Visio 2007 or 2010, select Data > Shape Data. Dock the window. Now, the Add-On screen remains displayed
while you work with the various shapes on the graphic, and your changes are saved immediately.

Menus
Table 2 describes the options of the Advanced Graphics Application menus.

Advanced Graphics Application Help 3
Table 2: Menu Options
Menu Option Description
File Save (Ctrl+S) Saves the current graphic file in SVG or SVGZ format to a location on the hard disk
or on the network to store the graphic.
Save As (F12) Saves the current graphic file under a new name.
Exit (Alt+F4) Closes the application.
Tools Graphics Binding Launches the AGA Binder.
(Ctrl+G)
Preferences (Ctrl+E) Launches the AGA Preferences dialog box.
Precache (Ctrl+P) Launches the AGA Precache window.
Help Online Help (Ctrl+F1) Launches the Advanced Graphics Application Help.
About AGA Displays information about the application, including copyright notice.

Toolbar
Table 3 describes the toolbar buttons of the Advanced Graphics Application.
Table 3: Toolbar Buttons
Button Description
Saves the current graphic file in SVG or SVGZ format to a location on the hard disk or on
the network to store the graphic.
Launches the AGA Binder.

Preferences
The Advanced Graphics Application launches dialog boxes to verify certain actions to guide you through the program.
For example, a dialog box appears asking whether you want to save your changes when you exit the Advanced
Graphics Application. Once you become familiar with the application, you can turn off some of these messages from
the Preferences menu. Figure 2 shows and Table 4 describes the options of the Preferences dialog box.
Figure 2: AGA Preferences Dialog Box

Advanced Graphics Application Help 4
Table 4: AGA Preferences Dialog Box
Option
1 Description
Hide warning on shape selection in Visio Prevents the warning message from appearing when selecting a different shape
in the Professional or Standard edition of Microsoft Visio 2003, 2007, or 2010
software.
Always Apply Changes When selected, applies any changes that have not been applied; otherwise, the
program discards the changes.
Hide warning on closing the editor Closes the Advanced Graphics Application without a warning message.
Always Save Changes Saves all changes without a warning message.
Hide warning on multiple shape selection Prevents the warning message from appearing when selecting multiple shapes
in the Professional or Standard edition of Microsoft Visio 2003, 2007, or 2010
software.
Hide warning on deletion of shape in Visio Prevents the warning message from appearing when deleting a shape in the
Professional or Standard edition of Microsoft Visio 2003, 2007, or 2010 software.

1 Table 12 lists the warning messages that appear in the Advanced Graphics Application. Table 12 also points out the messages
that disappear when you use the Preferences options described here.

Precache Feature
The Precache feature allows you to retrieve the values of objects used in your drawing before the graphic is rendered,
which improves graphic performance. These values are placed in Advanced Graphics memory immediately when
you open the graphic in the SMP UI. The drawing is then rendered and the values of all objects appear. If you do
not use the Precache feature, the object values are retrieved after the graphic appears, which slows down graphic
performance. Overuse of the Precache feature may also slow down the system; therefore, we recommend that you
specify only the most important objects in the Precache window.
For more information, see Working with the Precache Definition.

Action Codes
An Action Code is the coding information in a shape that specifies the animated presentation of data. For example,
you can create an animated spray for a duct humidifier using Action Codes. Action Codes include User Actions and
Dynamic Features.

User Actions
The Advanced Graphics Application triggers the defined dynamic feature in a shape to occur when a user acts upon
the shape. Table 5 describes the user actions configurable in the Advanced Graphics Application.
Table 5: User Actions
User Action Description
Left Click A left mouse click on a shape.
Example: ShowObjWindow(‘ADS1:NAE1/N2-1.AHU4.OA-T’);
Middle Click A middle mouse click on a shape.
Example: setlv(‘show_legend’,true);
Right Click A right mouse click on a shape.
Example: ShowCmdWindow(‘ADS1:NAE1/N2-1.AHU4.ZN-T’);
Mouse Down The mouse is clicked over a shape.
Example: setlv(‘mouse_down_on_temp’,true);

Advanced Graphics Application Help 5
Table 5: User Actions
User Action Description
Mouse Move The mouse moves around a shape.
Example:
setlv(‘mouse_move_on_map_X’,evt.clientX);setlv(‘mouse_move_on_map_Y’,evt.clientY);
Mouse Over The mouse moves over a shape.
Example: setlv(‘mouse_over_room4’,true);
Mouse Up The mouse is released on a shape.
Example: setlv(‘mouse_down_on_temp’,false);
Mouse Out The mouse moves off a shape.
Example: setlv(‘mouse_over_room4’,false);

Dynamic Features
The dynamics included in the shape deliver the dynamic capabilities for the shape. Table 6 describes the dynamics
available in the Advanced Graphics Application.
Table 6: Dynamic Features
Dynamic Feature Description
Animate Hide Hides and displays the shape so it appears to fade in and out of sight continuously at a
defined rate.
Animate Scale Increases and decreases the size of the shape so it appears to stretch and return to normal
size continuously at a defined rate.
Custom Actions Allows multiple JavaScript® statements for advanced functionality. This option allows you to
manually type the coding.
Discrete Color Changes the color of the shape from a list of colors. For example, the shape changes from
yellow to red when the Analog Value goes from Low Alarm to High Alarm.
Flash Makes the shape change from one color to another. For example, the shape flashes between
two colors continuously if the value goes beyond a maximum point.
Hide Makes the shape disappear.
Hyper Link Links a URL to the shape and opens in a separate window. For example, the shape jumps
to a user guide or Help file.
Include Attaches a JavaScript file to a shape.
Move Moves the shape from one location on the graphic to another.
Navigate Launches another advanced graphic file or item (for example, an Analog Value window).
Rotate Rotates the shape clockwise the specified number of degrees around an axis.
Scale Changes the size of a shape.
Set Fill Changes the fill color of a shape.
Sound Attaches a sound file (.wav) to a shape. For example, the shape makes a sound if the device
reaches abnormal values.
Span Color Changes the color of a shape to a color between two defined colors based on a numeric
value. For example, the shape appears purple halfway between red and blue.

Advanced Graphics Application Help 6
Table 6: Dynamic Features
Dynamic Feature Description
Spin Makes the shape spin clockwise or counterclockwise on its axis at a defined rate.
SVG Tag Attribute Adds advanced SVG coding to the shape.
Text Changes the string in a text box based on the value of an expression. For example, the text
box displays the Present Value of an object.
Three State Span Color Changes the color of a shape among three colors based on the value of a variable. For
example, a Temperature Bulb changes from blue to yellow to red as the temperature changes
from -18°C (0°F) to 21°C (70°F) to 43°C (110°F). A common color scheme is from green to
yellow to red.
Tooltip Adds Tooltip text to a shape.

See the Creating and Editing an Advanced Graphic (Overview) section for the overall process of creating an advanced
graphic. Specifically, see the Adding Action Codes to a Shape and Configuring Action Codes sections for details on
how to add and configure action codes. For background information on JavaScript, consult a reference book, such
as JavaScript: The Definitive Guide by David Flanagan.

Expression Builder
The Expression Builder allows you to build expressions to bind data to a shape using Graphic Object References.
The Expression Builder is shown in Figure 3 and described in Table 7.

Expression Syntax
The syntax for an expression depends on which action code or dynamic feature you have selected; however, for
the logic functions, there is a common syntax that applies:
Logic Function(‘Site Director:NxE Name/Point Reference.Attribute ID’ ,me);
Example for reading the present value of a zone temperature:
bsv(‘ADS1:NAE1/N2-1.ZN-T.85’,me);
The Logic Function is an abbreviation of the action that the statement is to perform. For example, bsv means read
a bound string value. Table 8 explains each of the valid logic functions.
The Site Director Name and NxE Name, along with the Point Reference, describe the location and name of the point.
A colon separates the Site Director and NAE/NCE names, which usually consist of an ADS:NxE combination. The
Point Reference is separated from the NxE by a forward slash.
The Attribute ID is a number that the Metasys system uses to identify a particular attribute. For example, the attribute
number for the Present Value of any object is 85. Other popular attribute numbers are 512 (Status), 28 (Description),
and 2390 (Name). The Expression Editor determines the attribute ID when you select the object’s attribute. If no
attribute ID or an invalid attribute ID is specified, an error in the Java® console occurs when you display the graphic
during runtime.
Product internationalization is the reason that attribute IDs are used instead of attribute names. For a list of all
attributes with their IDs, refer to the Metasys System Enumeration Sets Technical Bulletin (LIT-12011361).
The me keyword at the end of the statement is a convention used by the Advanced Graphics Application to enable
the dynamic feature to sign up for any change in value of the monitored attribute. For example, if the feature is
Discrete Color, the me keyword allows for a change in color to occur when the status of the linked attribute changes.

Advanced Graphics Application Help 7
Figure 3: Expression Builder

Table 7: Expression Builder
Option Description
Operator Buttons Click the button to insert its logical operation into the Generated Expression field.

Note: You can also use the NOT (!) and TERNARY (?) operators by editing the generated
expression.
Read/Write bound values or Local Provides a list of user logic function templates that read or write bound values or local
variables variables. Bound values are connected to an object that exists in the Metasys system
database, whereas local variables are values that can be referenced by expressions in
the graphic. See Table 8 for descriptions of the logic functions.
Object Reference/Local Variable Enter the local variable or Object Reference of the field point for which you want the
selected logic function template to operate. Click the Lookup button to bind data using
the AGA Binder.
Generated Expression Displays the expression (based on the Read/Write bound values or Local variables
selection and the Object Reference/Local Variable text) after clicking Build.

Logic Functions
Logic functions aid in programming the dynamic features of a shape. Logic functions trigger dynamics in the shape
based upon the attached system data. Insert logic functions using the Expression Builder. Table 8 describes the
logic functions available in the Advanced Graphics Application.

Advanced Graphics Application Help 8
Table 8: Logic Functions
Variable Script Description
Read a bound floating point bfv Reads an Object Reference in the Network Automation Engine (NAE)/Network
attribute value Control Engine (NCE)/Network Integration Engine (NIE) or Application and
Data Server (ADS)/Extended Application and Data Server (ADX), and returns
a floating value.
Note: Use this function to retrieve the precise value of an attribute (15
significant digits). For example, you could use it for converting
temperature calculations (°F to °C) or for providing a value to
non-textual action types such as Discrete Color.
Example:
bfv('ADS1:NAE1/N2-1.AHU4.RM-T.85, me)
Read a bound Boolean bbv Reads an Object Reference in the NAE/NCE/NIE or ADS/ADX, and returns
attribute value a Boolean value.
Note: Use this function to determine whether an object is in a specific state
(for example, on/off or alarm/normal). This logic function converts
the text to a Boolean true or false value.
Example:
bbv('ADS1:NAE1/N2-1.AHU4.SF-S.85, me)
Read a bound integer biv Reads an Object Reference in the NAE/NCE/NIE or ADS/ADX, and returns
attribute value an integer value.
Note: Use this function in cases where you do not want to translate the
state/mode/type set (enumeration) value of an object to text. For
example, use this option to compare the object’s status (high alarm
to low alarm).
Example:
biv('ADS1:NAE1/N2-1.AHU4.AV1.85, me)
Read a bound string value bsv Reads an Object Reference in the NAE/NCE/NIE or ADS/ADX, and returns
a string value.
Note: Use this function to display the state of an object as text. Enumerated
attributes are returned as text instead of numbers (for example,
Clean/Dirty instead of 0/1). Analog attributes are returned as rounded
values with units (for example, 74.2 Deg F instead of
74.1873547683635.) The bsv script is commonly used with the Text
action code.
Example:
bsv('ADS1:NAE1/N2-1.AHU4.FILTER.28, me)
Read a local floating point lfv Reads a local variable, and returns a floating value.
value
Read a local boolean point lbv Reads a local variable, and returns a Boolean value.
value
Read a local integer point liv Reads a local variable, and returns an integer value.
value
Read a local string point lsv Reads a local variable, and returns a string value.
value

Advanced Graphics Application Help 9
Table 8: Logic Functions
Variable Script Description
Select Color — Allows you to assign a color from a color selection window. The Expression
Builder can also use an RGB (red/green/blue) number given in hexadecimal
format to identify the color. This format contains # and three sets of numbers
representing the color intensity of red, green, and blue (for example, red
would be #340000).
Sets a local value setlv Modifies the value of a local variable.
Show Command Window ShowCmdWindow Displays the command window of the specified item/object.
Show Object Window ShowObjWindow Displays the default view/window of the specified item/object.

See the Creating and Editing an Advanced Graphic (Overview) section for the overall process of creating an advanced
graphic. Specifically, see the Using the Expression Builder section for details on how to build expressions.

AGA Binder
The AGA Binder assists you in building expressions by logging in to and selecting field points and references from
the SCT. Figure 4 shows the AGA Binder with the References tab active, and Table 9 describes the AGA Binder
menus and tabs. The fully qualified object reference of the selected item/object is copied to the Microsoft Windows®
clipboard so you can paste it into the expression.
Figure 4: AGA Binder

Table 9: AGA Binder
Menu/Tab Item Description
SCT Archives Displays the archives in the SCT.
References Displays the Navigation Tree of the selected SCT archive for choosing
field point references.

Advanced Graphics Application Help 10
Table 9: AGA Binder
Menu/Tab Item Description
File Exit (Ctrl+Q) Closes the AGA Binder.
Actions Login (Ctrl+L) Launches the SCT Login dialog box to log in to the local SCT or an
SCT on the network. To activate and use the features of the AGA
Binder, you must first log in to the SCT using this menu item.
Refresh Archives (Ctrl+R) Refreshes the data appearing in the AGA Binder to match the current
archives.
Get Field Points (Ctrl+G) Displays the field points for the device.
Show Attributes (Ctrl+H) Launches the Attribute dialog box that lists the attributes of the
selected object.

See the Creating and Editing an Advanced Graphic (Overview) section for the overall process of creating an advanced
graphic. Specifically, see the Using the AGA Binder section for details on how to bind data to shapes.

Graphics Example Stencil
The Graphics Example stencil contains prebuilt dynamic shapes for creating dynamic system graphics. Use the
Professional or Standard edition of Microsoft Visio 2003, 2007 or 2010 software and the Advanced Graphics
Generation Add-On to modify the shapes to suit the needs of the facility. Table 10 lists the sample shapes and their
prebuilt action codes. For more information on the action codes, see Table 5 and Table 6.
Table 10: Graphics Example Shapes
Shape Shape Name Action Codes
Differential (Diff) • Left Click - displays the default view/window of the object
Pressure • Right Click - displays the command window of the object
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Sound - plays a sound when in high/low alarm
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
• Tooltip - displays the object name
Humidity Sensor • Left Click - displays the default view/window of the object
• Right Click - displays the command window of the object
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Sound - plays a sound when in high/low alarm
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
• Tooltip - displays the object name

Advanced Graphics Application Help 11
Table 10: Graphics Example Shapes
Shape Shape Name Action Codes
Return Fan
2 • Left Click - displays the default view/window of the object
• Right Click - displays the command window of the object
• Mouse Out - hides the yellow command and status box
• Mouse Over - displays the yellow command and status box
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Hide - hides the yellow command and status box
• Span Color - changes color between red and green to indicate low and
high alarm
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
Right Horizontal • Left Click - displays the default view/window of the object
(Horz) Water Pump • Right Click - displays the command window of the object
• Mouse Out - hides the tooltip
• Mouse Over - displays the tooltip
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Discrete Color - changes the impeller red when off and green when
on
• Flash - changes the impeller color between white and red to indicate
low and high alarm
• Spin - moves the impeller clockwise when running
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
• Tooltip - displays the object name
RS9100 • Left Click - displays the default view/window of the object
• Right Click - displays the command window of the object
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Sound - plays a sound when in high/low alarm
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
• Tooltip - displays the object name

Advanced Graphics Application Help 12
Table 10: Graphics Example Shapes
Shape Shape Name Action Codes
Supply Fan
2 • Left Click - displays the default view/window of the object
• Right Click - displays the command window of the object
• Mouse Out - hides the yellow command and status box
• Mouse Over - displays the yellow command and status box
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Hide - hides the yellow command and status box
• Span Color - changes color between red and green to indicate low and
high alarm
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
Temperature (Temp) • Left Click - displays the default view/window of the object
Sensor • Right Click - displays the command window of the object
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Sound - plays a sound when in high/low alarm
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
• Tooltip - displays the object name
T-4000 • Left Click - displays the default view/window of the object
• Right Click - displays the command window of the object
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Sound - plays a sound when in high/low alarm
• SVG Tag Attribute - sets the object opacity
• Text- displays the Present Value of the object
• Tooltip - displays the object name
TE-6700 • Left Click - displays the default view/window of the object
• Right Click - displays the command window of the object
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Sound - plays a sound when in high/low alarm
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
• Tooltip - displays the object name

Advanced Graphics Application Help 13
Table 10: Graphics Example Shapes
Shape Shape Name Action Codes
TC9100 Stat • Left Click - displays the default view/window of the object
• Right Click - displays the command window of the object
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Sound - plays a sound when in high/low alarm
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
• Tooltip - displays the object name
TMZ • Left Click - displays the default view/window of the object
• Right Click - displays the command window of the object
• Animate Hide - displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Sound - plays a sound when in high/low alarm
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
• Tooltip - displays the object name
Water Pump • Left Click - displays the default view/window of the object
• Right Click - displays the command window of the object
• Mouse Out - hides the tooltip
• Mouse Over - displays the tooltip
• Animate Hide- displays/hides the text label when in high/low alarm
• Discrete Color - displays a different color for the Present Value text
1
box based on the object’s status
• Discrete Color - changes the impeller red when off and green when
on
• Flash - changes the impeller color between white and red to indicate
low and high alarm
• Spin - moves the impeller clockwise when running
• SVG Tag Attribute - sets the object opacity
• Text - displays the Present Value of the object
• Tooltip - displays the object name

1 Where 0=White, 10=Yellow, 15=Yellow, 30=Red, 34=Red, 70=Gray, 108=#8000, and 112=Black.
2 The Return Fan and Supply Fan shapes have Cmd Name, Cmd Desc, Sts Name, and Sts Desc labels with Text action codes.
Cmd Name and Cmd Desc reference the command output object for the mechanical device. Sts Name and Sts Desc reference
the status input object for the mechanical device.

Binding and Aliasing
The Advanced Graphics Application provides two methods for creating advanced graphics and binding data to
shapes. The first method is to use the Graphics Example shapes as defined and modify the object references in the
shape’s custom properties (Visio 2003) or shape data (Visio 2007 and 2010). The second method is to create your
own custom shapes or use the Graphics Example shapes and modify the action codes to create customized dynamic
shapes.

Advanced Graphics Application Help 14
The shapes in the Graphics Example stencil have custom properties or shape data entries on their right-click menus.
The object reference of all the shape’s action codes can be set using the custom properties (Figure 5) or shape data
(Figure 6 and Figure 7). See the Configuring Graphics Example Shapes section for details on how to edit the custom
properties or shape data.
Figure 5: Custom Properties on a Temperature Sensor (Visio 2003)

Figure 6: Shape Data on a Pre-Heat Coil (Visio 2007)

Advanced Graphics Application Help 15
Figure 7: Shape Data on a Temperature Sensor (Visio 2010)

If you choose to modify the action codes of a shape from the Graphics Example stencil, the custom properties or
shape data of that shape do not function after editing the action codes using the Advanced Graphics Application. If
you want to change any part of an existing Graphics Example shape (for example, you want to keep all of the
dynamics configured, but you want to change or add a dynamic), you cannot modify the custom properties or shape
data to indicate the object reference for that shape. You must use the Advanced Graphics Application to add the
object reference to each of the defined action codes and make the desired action code changes or additions. The
Configuring Action Codes for a Return Fan Shape Example section describes how to configure an existing Graphics
Example shape to use a different action code and how to add the object references to the defined action codes.
For information on creating new shapes and adding them to new stencils, refer to the Professional or Standard
edition of Microsoft Visio 2003, 2007, or 2010 software documentation. Then, add the new shape to your advanced
graphic and use the action codes to create the desired dynamics. For details on configuring action codes, see the
Adding Action Codes to a Shape section.
Aliased graphics employ a technique of string substitution in object references to allow a single graphic to be used
with multiple mechanical systems. For example, create a single graphic to use for all Variable Air Volume (VAV)
controllers, then create an alias to use for the other graphics. For an example on how to create an aliased graphic,
see the Creating an Aliased Graphic section.

Advanced Graphics Application Help 16
User Graphics Tool
The Metasys system includes a User Graphics Tool (UGT) that accepts standard graphics. The graphics provide a
visual representation of the monitored systems and enable you to quickly check the status of systems and recognize
unusual conditions. You can design graphics to allow you to navigate through buildings, floors, and other areas,
viewing the building systems and control processes.

Advanced Graphics Viewing
The SMP UI displays advanced graphics with real-time controller field point data, and allows building operators to
command and update points. Advanced graphics allow you to use a wider range of dynamics in your system graphics.
After selecting an advanced graphic in the Metasys system navigation tree, the advanced graphic appears in the
SMP UI.
In the SMP UI, advanced graphics do not offer the functionality and buttons present in the UGT. If you click the Edit
button, a toolbar appears that allows you to replace the current graphic with a new advanced graphic using or
clear the current advanced graphic using the Clear button.
Figure 8 shows an advanced graphic viewed in the SMP UI. See Viewing a Graphic.
Figure 8: Advanced Graphic

Workflow
Figure 9 shows the workflow for creating and viewing advanced graphics.

Advanced Graphics Application Help 17
Figure 9: Advanced Graphics Workflow Diagram

Advanced Graphics Application Help 18
Advanced Graphics Steps
Creating and Editing an Advanced Graphic (Overview)
Use this procedure to create graphics using existing shapes in the Graphics Example stencil with the Advanced
Graphics Application and Visio Professional 2003, 2007, or 2010 software. Both of these procedures require you to
work with the Visio software source file, and then place the new graphic in the Metasys system or replace the existing
graphic with a new graphic. See the Workflow section.
Note: If desired, create and save any new shapes and stencils for use in your graphic as instructed in the Professional
or Standard edition of Microsoft Visio 2003, 2007, or 2010 software product documentation.
1. In the Professional or Standard edition of Microsoft Visio 2003, 2007, or 2010 software, open an existing graphic
or create a new graphic (Visio drawing in VSD format). Use the shapes in the Graphics Example stencil and
other stencil libraries to create the graphic in the drawing workspace.
Note: To access the Graphics Example stencil, select File > Shapes > Graphics Example.
2. Configure the shapes for the preferred dynamic features and bind the graphic with field point data.
3. Log in to the SMP UI.
• To bind data to existing shapes in the Graphics Example stencil, see the Configuring Graphics Example
Shapes section.
• To use the Precache feature, see Working with the Precache Definition.
• To configure and bind data to shapes using action codes, see the Adding Action Codes to a Shape section.
Note: If you want to create an aliased graphic (for example, one graphic used for all VAVs), see the Creating
an Aliased Graphic section.
4. If you are creating a new graphic, insert a graphic object into the SMP UI and import the advanced graphic. See
the Inserting an Advanced Graphic to the UGT section.
If you are replacing an existing advanced graphic with a new advanced graphic, display the advanced graphic
you are replacing and go to Step 10 in Inserting an Advanced Graphic to the UGT.

Configuring Graphics Example Shapes
Use this procedure to configure the custom properties of the shapes in the Graphics Example stencil. Graphics
Example shapes are already configured for dynamic capabilities. Modify the custom properties to bind the shapes
to field point data.
1. If you are using Visio 2003, right-click the shape and then click Shape > Custom Properties. The Custom Properties
dialog box appears. See Figure 5. If you are using Visio 2007 or 2010, right-click the shape and then click Data
> Shape Data. The Shape Data dialog box appears. See Figure 7.
2. Use the AGA Binder to locate and copy the fully qualified object reference you want to bind to the shape. For
details on how to use the AGA Binder, see the Using the AGA Binder section.
Note: Do not enter attribute-level references when using this method.
3. Paste the fully qualified object reference in the ObjectReference field of the Custom Properties or Shape Data
dialog box.
4. Click OK.
5. From the Visio software File menu, select Save Advanced Graphics to save the changes to the graphic in the
SVG or SVGZ file.
Note: Alternatively, you can click Save in the Advanced Graphics Application or select Save from the Advanced
Graphics Application File menu.

Advanced Graphics Application Help 19
6. On the Visio software File menu, click Save to save the changes to the Visio drawing in VSD format. The VSD
file is the file format used by the Professional or Standard edition of Microsoft Visio 2003, 2007, or 2010 software.
The VSD drawing is the file to open when you want to edit a graphic using the Professional or Standard edition
of Microsoft Visio 2003, 2007, or 2010 software and the Advanced Graphics Application.
Note: Make sure you click an empty space on the drawing workspace before saving. If one of the shapes in
the graphic is selected, the application only saves changes to that shape.

Advanced Graphics Application Help 20
Working with the Precache Definition
1. On the Tools menu, click Precache. The Precache window appears (Figure 10).
Figure 10: Precache Window

2. Add the objects you want to precache while using the Advanced Graphics Application.
Note: To delete all items in the Precache definition, click Delete Precache. If you click Delete Precache and
apply the changes, there is no undo. The Precache is emptied.

If you would like to delete one item from the list, manually remove the item from the list by selecting it
and pressing the Delete key.
3. Click Apply Changes to save the settings.

Adding Action Codes to a Shape
Use this procedure to add dynamic capabilities, such as spinning, flashing, and rotating, to a shape.
1. In the Professional or Standard edition of Microsoft Visio 2003, 2007, or 2010 software, select a shape.
2. On the Tools menu, click Add-Ons > AGAActionCodeAddOn. The Advanced Graphics Application main
screen, ActionCode AddOn Form, appears. See Figure 1.
3. Click to select the check boxes for the preferred User Actions and Dynamic Features for the shape. The selected
User Actions and Dynamic Features appear in the Action Codes drop-down menu. See Table 5 and Table 6
for information on each User Action and Dynamic Feature.
4. In the Action Codes box, select and configure the User Actions and Dynamic Features assigned to the shape.
The configuration menus for the Action Codes appear in the top panel of the Advanced Graphics Application
screen. See the Configuring Action Codes section for information on how to configure each of the Action Codes.
Some of the Action Codes use the Expression Builder and the AGA Binder. See the Using the Expression
Builder and the Using the AGA Binder sections for information on how to create expressions and bind data.

Advanced Graphics Application Help 21
5. Click Apply Changes after configuring all Action Codes for the shape.
6. On the Visio software File menu, click Save Advanced Graphics to save the changes to the graphic in the
SVG or SVGZ file.
Note: Alternatively, you can click the Save button in the Advanced Graphics Application or select Save from
the Advanced Graphics Application's File menu.

The first time you save the graphic, the Save As dialog box appears. Select a location on the hard disk
or on the network to store the graphic. Type a name for the graphic in the File name box. Then select
SVG or SVGZ format and click Save.
7. On the Advanced Graphics File menu, click Exit to close the Advanced Graphics Application.
8. Perform Step 1 through Step 7 for each shape in the graphic that you want to animate.
Note: You can configure individual action codes on parts of the graphic and then group them together in Visio
software and configure action codes for the grouped section as well.
9. On the Visio software File menu, click Save to save the changes to the Visio drawing in V

Показано початок документа. Повний текст — у PDF за посиланням вище.

Позиції каталогу з цим документом

Документ виробника, опублікований як довідковий матеріал на обладнання, яке ми постачаємо. Правовласник може попросити прибрати його — приберемо.