EIKON LogicBuilder v4

User's Guide
Automated Logic Corporation • 1150 Roberts Blvd. • Kennesaw, GA 30144 • 770/429-3000 • Fax 770/429-3001 •
www.automatedlogic.com • © 2008 Automated Logic Corporation. All rights reserved throughout the world. Automated Logic
Corporation, the Automated Logic logo, WebCTRL, EIKON, BACview, SuperVision, and InterOp are registered trademarks, and Alert is a
®
trademark of Automated Logic Corporation. BACnet is a registered trademark of ASHRAE. All other brand and product names are
trademarked by their respective companies.
Contents
What is EIKON® LogicBuilder?................................................................................................................. 1
Getting to know EIKON® LogicBuilder....................................................................................................... 2
Determining the control program type ....................................................................................................... 4
Normal for all control modules except U line or ZN line .................................................................... 4
UNI for U line control modules ........................................................................................................ 5
ZN for ZN line control modules ........................................................................................................ 6
Developing the logic ................................................................................................................................ 8
To begin a control program ............................................................................................................. 8
To place microblocks ...................................................................................................................... 9
To draw wires and labels ................................................................................................................. 9
To view errors ............................................................................................................................... 11
To add text ................................................................................................................................... 11
To add lines and shapes ............................................................................................................... 12
To create a custom microblock ..................................................................................................... 13
To select properties for ViewBuilder graphics ................................................................................ 14
Formatting Properties pages .................................................................................................................. 15
To reorder items on the Properties page ........................................................................................ 15
To use the Text microblock to format text ....................................................................................... 16
Editing Properties page text using special characters .................................................................... 18
Formatting a microblock property ................................................................................................. 19
Simulating a control program ................................................................................................................. 23
EIKON® LogicBuilder productivity tools .................................................................................................. 25
To create and use symbols ............................................................................................................ 25
To use EquipmentBuilder .............................................................................................................. 26
To compare properties of multiple microblocks ............................................................................. 26
To find a microblock or label ......................................................................................................... 27
To find identical labels ................................................................................................................. 27
To show a logical path .................................................................................................................. 27
To show a wire's source microblock .............................................................................................. 27
To use custom alarm and schedule categories ......................................................................................... 28
Miscellaneous EIKON® LogicBuilder menu commands ............................................................................ 29
Working with control programs created in the EIKON® for WebCTRL application ......................................... 30
Index ................................................................................................................................................... 32
What is EIKON® LogicBuilder?
The EIKON® LogicBuilder application creates control programs to control equipment, from single
pieces of equipment to complex energy management functions.
You build control programs using individual blocks of programming code called microblocks. You
determine the properties for each microblock and connect the microblocks with graphical wires to
create a sequence of operation.
A control program is assigned to a piece of equipment in SiteBuilder, then the WebCTRL® application
downloads it into the control module that will directly control and monitor the equipment. You can
change editable properties and view noneditable properties of control programs through the
WebCTRL® interface.

The typical procedure for creating a control program includes the following steps:
1 Determine the control program type (page 4).
2 Develop the logic (page 8).
3 Format Properties pages (page 15).
4 Simulate the control program (page 23).

Or, you can use EquipmentBuilder (page 26) to generate a control program and, optionally, the
corresponding equipment graphic.

© 2008 Automated Logic Corporation 1

Getting to know EIKON® LogicBuilder

TIPS
• If the Property Editor is not visible, double-click an object in the workspace.
• You can use the Property Editor as a free-standing window, or you can select Options > Dock
Property Editor to dock it in the EIKON® LogicBuilder window.
• Keyboard shortcuts are shown beside their corresponding commands in the menus.
• Press Ctrl + an arrow key to nudge selected objects. Press Shift+Ctrl while using the arrow keys to
increase the size of the nudge.
• Click to undo 1 action, or click the drop-down arrow next to it to undo multiple actions at one
time. Click or its drop-down arrow to redo actions. The number of actions you can undo or redo
depends on the size of your computer's memory.
• The workspace size has no limit.
• Press Home to position the upper left corner of the workspace in the upper left corner of the
window.
• Press End to jump to the bottom of the control program.
• Use the arrow keys or your mouse's scroll wheel to scroll through the workspace.

© 2008 Automated Logic Corporation 2

 • From the Options menu you can:
○ Suppress the Logic page so that it cannot be seen in the WebCTRL® interface
○ Hide or show the workspace grid
○ Enable Snap Figures and Text to Grid to constrain movement to 8 pixels for quick alignment;
disable this feature for 1-pixel movement
○ Select metric units of measurement for setpoint microblocks
○ Zoom the view to 50, 100, or 200%

© 2008 Automated Logic Corporation 3

Determining the control program type
Before you create a control program, first determine the control program type (Normal, UNI, or ZN), and
then follow the appropriate rules below.

Normal for all control modules except U line or ZN line

• Make sure a control program broadcasts a single color by using one of the following:
○ 1 Setpoint microblock
○ 1 Set Color microblock
○ 1 or more Set Color If True microblocks
• Each Time Clock microblock in a control program must have a unique schedule category.
• To use an RS sensor, the control program must have an RS Zone Sensor microblock.
• To use a basic LogiStat or LogiStat Plus sensor with an SE line control module, the control program
must have a LogiStat Zone Sensor microblock or an RS Zone Sensor microblock.

© 2008 Automated Logic Corporation 4

UNI for U line control modules

Required microblocks Microblocks not supported

• BACnet Time Clock • Pulse to Analog
• Setpoint with a direct input named • Setpoint Optimization
ZONE TEMP from one of the following • Set Color or Set Color if True
microblocks:
• Dewpoint Temp Calculator
○ BACnet Analog Input
○ LogiStat Zone Sensor (ExecB) • Wet Bulb Temp Calculator
• Toggle
• Lead/Standby
• Integrator
• RS Zone Sensor
• RS Zone Sensor with Fan Control

NOTES
• Each Time Clock microblock in a control program must have a unique schedule category.
• The setpoint microblock's cooling setpoint must be wired to a PID Direct Acting microblock.
• The setpoint microblock's heating setpoint must be wired to a PID Reverse Acting microblock.
• Set time delay functions and trend intervals to at least 1 minute because U line control
modules do not support time-critical applications.
• To use a LogiStat sensor, the control program must have a LogiStat Zone Sensor microblock.
NOTE The U220 does not support any LogiStat sensor.
• For the actuator in a v+ control module to be protected by the control module warranty, the
control program must contain the following microblocks:
○ Zone Controller
○ U-line Airflow Control
• The U220 is designed to handle miscellaneous pieces of equipment such as exhaust fans and
room lighting. In many cases, these applications will not meet the unitary control criteria
required to enable the UNI option. You may use any of the standard U220 zone control
programs in the EquipmentBuilder Library.
• You can download ZN control programs into a UNI. If your control program does not meet UNI
rules, try saving it as a ZN control program.
• If your control program does not meet UNI or ZN rules but is appropriate for a zone control
application, you can get the control program tagged by Automated Logic®. Review Automated
Logic®'s tagging policy
(http://accounts.automatedlogic.com/sales/policy.nsf/7efc5bb11196e87185256b3c00785
ad2/eaffdfa1ccd769d88525735b004e7864!OpenDocument) on the
accounts.automatedlogic.com website, then follow the instructions under "How do I get a
control program tagged?".

© 2008 Automated Logic Corporation 5

ZN for ZN line control modules
ZN control modules are designed for zone-level comfort control applications. They are not designed for
air handlers, central plants, or other applications that do not control the temperature in a single area.

Required microblocks Microblocks not supported

• BACnet Time Clock • Setpoint Optimization
• Setpoint with a direct input named • Set Color or Set Color if True
ZONE TEMP from one of the following • Toggle
microblocks:
• Lead/Standby
○ BACnet Analog Input
• Integrator
○ Analog Network Input
○ Analog Network Input 2 • Total Analog Input
○ LogiStat or RS Zone Sensor • Average Analog Input
NOTE Required microblocks must be located in • Minimum Analog Input
the opening pane (1024 x 600 pixels) of the • Maximum Analog Input
control program.

© 2008 Automated Logic Corporation 6

 Required microblocks Microblocks not supported

NOTES
• Each Time Clock microblock in a control program must have a unique schedule category.
• The Zone Controller microblock provides primary heating and cooling PID control loops. If you
need an additional control loop, you may use one PID microblock, but no more than one.
• To use an RS sensor, the control program must have an RS Zone Sensor microblock.
• To use a basic LogiStat or LogiStat Plus sensor, the control program must have a LogiStat
Zone Sensor microblock or an RS Zone Sensor microblock.
NOTE The ZN220 does not support any LogiStat sensor. Other ZN's do not support the
LogiStat Pro.
• A ZN control program can have a maximum of 200 microblocks (excluding labels, text, and
status microblocks).
• For the actuator in a v+ control module to be protected by the control module warranty, the
control program must contain the following microblocks:
○ Zone Controller
○ Airflow Control
• The ZN220 is designed to handle miscellaneous pieces of equipment such as exhaust fans
and room lighting. In many cases, these applications will not meet the zone criteria required by
to enable the ZN option. You may use any of the standard ZN220 zone control programs in the
EquipmentBuilder Library.
• Tagging:
○ A control program that does not meet the above ZN criteria but is appropriate for a zone
control application can be tagged by Automated Logic® as a ZN control program.
○ Only tagged OCL microblocks can be used in a ZN control program. Get a tagged OCL
microblock from the dealer website. Select Engineering > StdAppLibrary > Standard
Application Library > WebCTRL > ZN551 & ZN253 Zone Applications & OCL Microblocks.
Or, get Automated Logic® to tag your own OCL microblock.
○ Each microblock inside an untagged custom microblock counts against the ZN
200-microblock limit. However, a tagged custom microblock counts as only 1 microblock.
You can use tagged custom microblocks available in some applications in
EquipmentBuilder. Or, get Automated Logic® to tag your own custom microblock.
○ To get a control program, OCL microblock, or custom microblock tagged, review
Automated Logic®'s tagging policy
(http://accounts.automatedlogic.com/sales/policy.nsf/7efc5bb11196e87185256b3c00
785ad2/eaffdfa1ccd769d88525735b004e7864!OpenDocument) on the dealer website,
then follow the instructions under "How do I get a control program tagged?".
• You cannot suppress the logic page for a ZN control program.

© 2008 Automated Logic Corporation 7

Developing the logic
Use the following procedures to develop your control program.

To begin a control program

The EIKON® LogicBuilder application creates a .equipment file that is the control program that you
download into a control module.
1 In the EIKON® LogicBuilder application, select 1 of the following from the Control Program menu:
○ Normal for downloading into ME, M, SE, S, and LGR line control modules or an Equipment
Portal
○ UNI for downloading into U line control modules
○ ZN for downloading into ZN line control modules or a Room Controller
2 Select File > Save as.
3 Name the .equipment file, then save it in the webroot\<system_name>\programs folder.
NOTE File names must:
○ Begin with a letter.
○ Not contain spaces or periods.
○ Be unique throughout a WebCTRL® system.
4 Click Save.

NOTES
• Select File > Info to view the File Name, Directory, Date Created, and Date Last Revised. You can
also select a Custom Icon that the WebCTRL® navigation tree will show for the equipment.
• To use °C for setpoint microblocks in a control program, select Options > Metric. If you change the
Metric option for an existing control program, you must delete and reinsert all setpoint
microblocks.
• To make all future control programs use the Metric option by default, select Options >
Preferences, then select the Create new control programs as metric checkbox.

© 2008 Automated Logic Corporation 8

To place microblocks
1 Right-click the Microblock palette.

2 Click the icon of the microblock you want to use.

3 Move the cursor into the workspace.
NOTE Press and hold Shift if you want to place 2 or more of the selected microblock.
4 Click to place the microblock.
5 Edit the microblock's properties in the Property Editor.
NOTES
○ If the Property Editor is not open, double-click the microblock.
○ Red text in a field indicates an invalid value.

TIPS
• Place all input microblocks on the left side of the workspace and all output microblocks on the
right.
• Arrange microblocks so that logic flows from left to right and the sequence of operation can be
easily followed.
• Hold Ctrl as you move a microblock to detach it from its wire.
• The order of items on a WebCTRL® Properties page is determined by the order in which
microblocks are placed when developing the control program in the EIKON® LogicBuilder
application. Select Reorder > Edit Order to rearrange items on the Properties page.

To draw wires and labels

Wires are special lines in a control program that transmit values from one microblock to another. Solid
wires transmit analog data; dashed wires transmit binary data. Wires connect microblock inputs and
outputs. They can also connect to other wires.
Output and input labels connect items just as wires do. Use labels when a value is needed in several
places within a control program or when wires would clutter or complicate the control program.

© 2008 Automated Logic Corporation 9

 To draw wires
1 Hold your cursor over a microblock nib until the cursor changes to crosshairs, then click and drag
in the direction you want the wire to go.
NOTE A wire automatically makes a 90° turn if you drag away from a straight line. To create
additional 90° turns, right-click while continuing to hold down the left mouse button.
2 Release the left mouse button to end the wire.
NOTES
○ The red error indicator at the microblock's nib disappears if the wire connected properly.
○ When drawing wires between closely placed microblocks, you can temporarily disable the
snap-to feature by pressing Ctrl while drawing a wire.

To change an existing wire

NOTE If you move a microblock, connected wires move with it.
1 Right-click the wire, then select Edit Shape.
2 Do one of the following:
○ Click and drag any wire segment in the direction of the move icon.
○ Right-click where you want to add a joint on a wire, then select Add Joint.
○ Right-click a green wire joint, then select Remove Joint.
○ Click a wire, then select a different wire from the Type drop-down list.

To add labels
1 Select the Label tool.

2 Move the cursor to the nib of a microblock or to the end of a wire, then click the workspace.

TIP To quickly change the label's direction, press I (for Input label) or O (for Output label) while
moving the label.
3 Type a name in the Label Text field of the Property Editor.
NOTE If the Property Editor is not open, double-click the label.
4 Optional: Change the Direction of the label in the Property Editor.

© 2008 Automated Logic Corporation 10

 To change a label's text
1 Select the label.
NOTE To locate the label, see To find a microblock or label (page 27).
2 Edit the Label Text field.
NOTE If the Property Editor is not open, double-click the label.
3 Optional: Click Rename all labels named '__' to change all labels that have the same label text.

To view errors
The EIKON® LogicBuilder application checks for errors as you build your control program and indicates
errors with red dots, wires, and boxes.
1 Click in the lower right corner or select Control Program > Errors on the menu bar to view the
errors.
2 Click an error in the list to highlight its location in the workspace.

NOTE You cannot download a program that has errors.

To add text
Use the Text tool to add descriptive text to the control program.
1 Select the Text tool.

2 Click in the workspace where you want the text to begin.

3 Edit the text and its properties in the Property Editor. See table below.
NOTE If the Property Editor is not open, double-click the text.

Field Notes
Text Type the comment you want to add to the control program.
Font Select a font. Be sure that all system computers have the font installed.
Size Choose a point size from the drop-down list.
Style Check Bold, Italics, or both.
Foreground Click the color swatch to select the color of the text.
Transparent Check to remove the background color and pattern.
Background
Background Click the color swatch to select the color of the box behind the text.

NOTE To change the default settings for all text that you will add to the control program, select Options
> Palette. Change the settings on the Font tab.

© 2008 Automated Logic Corporation 11

 To arrange text blocks
1 Select 1 or more text blocks.
2 Right-click one of the text blocks, then select 1 of the following:
○ Bring Forward
○ Bring to Front
○ Send Backward
○ Send to Back

To add lines and shapes

Use lines and shapes to organize and clarify the control program.

To draw a line or polygon

1 Select the line or polygon tool.
NOTE To draw multiple similar figures, press and hold Shift as you draw them.
2 To begin drawing the figure in the workspace, click and hold the left mouse button as you move
the mouse.
3 While holding down the left mouse button, right-click to add angles.
4 Release the left mouse button to complete the line or polygon.

NOTE To change the shape of an existing figure, right-click the figure, then select Edit Shape. Click and
drag a green point to move it.

To draw a rectangle or ellipse

1 Select the rectangle or circle tool.
NOTE To draw multiple similar figures, press and hold Shift as you draw them.
2 Click and drag in the workspace to begin drawing the figure.
3 Release the mouse to complete the rectangle or ellipse.

NOTE Hold Ctrl while you drag to draw a square or a circle.

© 2008 Automated Logic Corporation 12

 To change the color or pattern of figures
To change:
• The color or pattern of a selected figure, click the appropriate rectangle in the Property Editor, and
then make your selection. If the Property Editor is not open, double-click the figure.
NOTE Select the red cross-hatch pattern for no fill.
• The color or pattern of multiple selected figures, select Options > Palette.
NOTE Select the red cross-hatch pattern for no fill.
• The default color or pattern for all figures that you will draw, select Options > Palette.

To arrange figures
1 Select 1 or more figures.
2 Right-click 1 of the figures, then select 1 of the following:
○ Bring Forward
○ Bring to Front
○ Send Backward
○ Send to Back

To create a custom microblock

If you want simple, easy-to-troubleshoot Logic pages, put complicated calculations in a custom
microblock.
NOTES
• You cannot view or change a custom microblock's logic in the WebCTRL® interface.
• You can put custom microblocks inside other custom microblocks.

© 2008 Automated Logic Corporation 13

 To create a custom microblock
1 Select Custom Microblocks > Add New Custom Microblock.
2 Right-click the custom microblock, then select Step Inside Custom Microblock.
3 In the custom microblock window, place custom I/O microblocks to create nibs on the custom
microblock.
NOTE The order of the microblocks in the custom microblock window determines the location of
the nibs on the custom microblock.
4 Place other microblocks, wires, and labels to create the custom microblock's logic.
5 To return to the main workspace, click Control Program at the top of the custom microblock
window.

To select properties for ViewBuilder graphics

The EIKON® LogicBuilder application lets you select the microblock property values that you want to
appear on a WebCTRL® graphic. This allows the graphics creator to see the property values and
quickly obtain their paths in ViewBuilder. These microblock property selections are saved when you
save the control program.

1 Right-click a microblock in the workspace, then choose Select Properties For Graphics.
2 Check any property whose value you want to display on a graphic.
NOTE To see all properties, clear the checkbox Show properties typically shown on graphics.
3 Optional: To add a comment for a property such as "Do not include units", select the property and

then click , or you can double-click the property.

NOTE Select Control Program > Properties For Graphics to see all the properties that you selected in
the control program. In the Comments box, you can type a comment that is not for a specific property.
To delete a property, select it and then click .

© 2008 Automated Logic Corporation 14

Formatting Properties pages
Making a control program automatically creates a WebCTRL® Properties page. The initial properties
displayed on a Properties page are defined in the EIKON® LogicBuilder Property Editor.
You can preview Properties pages by running the system without connecting to control modules.

In the control program, you can change the way text appears on the Properties page by using a Text
microblock or by editing a microblock's Property Page Text field in the Property Editor.

NOTE If you change a control program after downloading it to the control module, you must:
1 Reload the control program. See "Working with control programs" in WebCTRL® Help.
2 Download the control program. See "Downloading system changes to control modules" in
WebCTRL® Help.

To reorder items on the Properties page

1 Select Reorder > Edit Order.
2 Select the microblock(s) you want to move. Ctrl+click or Shift+click to select and move multiple
microblocks.
3 Use the buttons at the right to move, cut, or paste microblocks.
4 Click OK.

NOTES
• To find a single microblock in the Edit Order dialog box, do one of the following:
○ Right-click the microblock in the workspace, then select Show in Edit Order.
○ In the Edit Order dialog box, click to search for the microblock.

• To edit a microblock's Property Page Text from the Edit Order dialog box, do one of the following:
○ Double-click the microblock.

○ Select it and then click .

© 2008 Automated Logic Corporation 15

To use the Text microblock to format text
The Text microblock allows you to format text, add horizontal lines, and arrange items on the
Properties page. Text microblocks placed in a control program in the EIKON® LogicBuilder application
are not visible on the WebCTRL® Logic page.
1 Place a Text microblock in the workspace to the right of the microblock logic.
2 In the Property Editor, select a format option from the Type drop-down list. See table below.
NOTE If the Property Editor is not open, double-click the microblock.
3 Type text in the Property Page Text field.

Text Type Notes

Plain For creating plain text.
Separator To create a horizontal line on the Properties page, often used to offset or
group information, choose Separator as the Text Type. If you would like text
to appear on the separator line, type the text in the Property Page Text
field.
Bold For creating bold text.
Expand Begin Closed To format a section using expanded formatting, first insert a Text
Expand Begin Opened microblock with the Text Type set as Expand Begin Closed or Expand Begin
Opened, depending on how you want the area to display when first viewed.
Expand End
If you would like text to appear on your expandable line, type the text in the
Property Page Text field.

You must also insert a Text microblock with the Text Type set as Expand
End at the end of the section you wish to group together.
TableBegin To align data in a table, insert a Text microblock with the Text Type set as
TableEnd Table Begin. To complete the table, insert a Text microblock with the Text
Type set as Table End after the last item you want to include in the table.

NOTE When working with a table within an expanded section, make sure
the table begins after the Expand Begin and ends before the Expand End.

© 2008 Automated Logic Corporation 16

 Text Type Notes
Conditional Hide Begin You can hide part of the Properties page based on a value from a specific
Conditional Hide End microblock. For example, you can specify that the Properties page text from
an Analog Input microblock will only appear on the Properties page if the
value is above 85. The expression is evaluated relative to the entire control
program, not at that particular microblock.
Place a Text microblock with the Text Type set as Conditional Hide Begin
before the microblock to be evaluated and another set to Conditional Hide
End after it. Type a conditional expression in the Properties Page Text field
of the Text microblock. Microblock properties may be referenced between
the dollar signs ($), and the expression must be Boolean. For example, to
show the microblock Properties page text only when the present value of
the point named Zone Temp is greater than 85, the expression would be
"$Zone_Temp/present_value$ >85".
NOTES
• When referring to the name of a point, use the RefName rather than the
Display Name.
• Technical Support does not provide assistance with writing and editing
Javascript. See Javascript textbooks, available in most bookstores, for
help with Javascript.

TIP If you are adding the Conditional Hide formatting after the control
program has been designed or would prefer to group all of the Text
microblocks within the control program, use the Reorder menu to correctly
place the Text microblocks.
Important Begin These options are currently not used.
Important End

© 2008 Automated Logic Corporation 17

Editing Properties page text using special characters
For many microblocks, you can edit or format Properties page text in the microblock's Property Page
Text field using special characters described below.

To... In the Property Page Text field, Example

type...
Display The microblock property between The value is $Present_Value$
a microblock 2 dollar signs. Displays:
property NOTE The microblock property
The value is 69.
that you type is not
case-sensitive.
See the Microblock reference for
property reference names.
See Formatting a microblock
property (page 19).
Make a { to begin a table, then } to end {[|History Recorder: |Current cycle =
column-aligned the table |$Current/Latched_Value$| on
table |$Current/Latched_Time$|$Current/Lat
[ to begin a row, then ]^$ to ched_Date$
end a row. |since|$Current/Reset_Time$|$Current
/
Exception: Type ] to end last row
Reset_Date$]^$
in table.
[||Previous cycle =
| (a pipe) to align cells |$Previous/Latched_Value$| on
|$Previous/Latched_Time$|$Previous/L
atched_Date$
|since|$Previous/Reset_Time$|$Previo
us/Reset_Date$]}
Displays:

Hide default text ^## if Property Page Text field is

empty.
If the Property Page Text field
shows the default text, delete
the text.
Display two ^$ at the end of the text for the MB#1: Enable when Supply Temp is more
microblock first microblock than $Constant$ (F) ^$
properties on the MB#2: Disable when $Hyst$ (F) below
same line Zone Temp.
Displays:

© 2008 Automated Logic Corporation 18

 To... In the Property Page Text field, Example
type...
Begin a new line of ^\ where you want a new line to Time for daily trend report:^\ ___
text begin hh:mm 24 hr
Displays:
Time for daily trend report:
02:00 hh:mm 24 hr
Bold text !{text!} !{NOTE!} Must be enabled for...
Displays:
NOTE Must be enabled for...
Make a line of text ^( at the beginning of the text
not wrap in the and ^) at the end
action pane
Display one of the \x, where x is the character you Do not change \!
following want to display Displays:
characters:
Do not change!
^\${}[]|!

Formatting a microblock property

To add a microblock property in a microblock's Properties Page Text field, type the property between 2
dollar signs. For example, $current_Value$. This is called an expression.
NOTE The microblock property that you type is not case-sensitive.
Each microblock property has default formatting that determines how it looks on the Properties page.
You can change the way it looks by adding a control and one or more parameters to the expression.
EXAMPLES
• To display the present value of Duty cycle in a time format that shows minutes and seconds, type
$Present_Value:control=”minsec”$
• To display the Period microblock property in a time format that shows minutes and seconds and
make it editable, type $Period:control="minsec" editable="true"$.

Breakdown of an expression

The entire expression is between 2 dollar signs.

A microblock property Example: Period

A colon
Type a colon after the microblock property to add a control.

© 2008 Automated Logic Corporation 19

 control=
A control determines how a property is displayed on the Properties page. Include a control= statement
in the expression only if you want to use a control other than the default. Type control=, followed by
the control name .

A control Example: "minsec"

Type the control between quotation marks. See table below.

A space
Type a space after a control statement or a parameter statement.

A parameter Example: editable=

You can add one or more parameters to the expression. To specify a control, type the name of the
parameter (see table below), an equal sign, and then a value .

A parameter value Example: "true"

See table below.

© 2008 Automated Logic Corporation 20

 Controls and parameters
A microblock property data type determines the type of control that can be used.

To display a... Data must be..

Control Parameter Parameter value
Checkbox Boolean button type WidgetImageButton.TOGGLE
Example: A binary
parameter's present editable true or false
value (Default value is true.)
truewhendown true or false
Check mark appears when (Default value is true.)
the value is false instead of
true.

Radio button Boolean button type WidgetImageButton.RADIO

Example: A binary
parameter's present editable true or false
value (Default value is true.)
or truewhendown true or false
Button is selected when the (Default value is true.)
Integer value is false instead of
Example: An analog true.
parameter's present
value index any integer
For integer or enumerated (Default value is null.)
or
values, index is the number
of the state the radio
Enumerated
button is to represent.
Example: A binary,
analog, or multi-state
parameter's present
value

Text Character string charstring editable true or false

Example: A point's (Default value is true.)
display name

Date Date date editable true or false

Example: A wire lock's (Default value is true.)
begin date/end date
hasdayofweek true or false
Displays the day of the (Default value is true.)
week with the date.

© 2008 Automated Logic Corporation 21

To display a... Data must be..
Control Parameter Parameter value
Number Integer number editable true or false
(no decimal) (Default value is true.)
Example: An analog
parameter's present digits_right_of_decimal number of digits
value (real number only) (Default value is null.)
or digits_left_of_decimal number of digits
(Default value is null.)
Real
showplussign true or false
(has decimal)
(Default value is false.)
Example: An analog
parameter's present scalingfactor any floating point number
value Multiplies the actual value except 0
or by the scalingfactor value. (Default value is 1.)
Example, to convert watts
Unsigned to kilowatts, use .001 as
Example: Any point's the scaling factor value.
expander number

Droplist Enumerated droplist editable true or false

Example: A binary, (Default value is true.)
analog, or multi-state
parameter's present
value

Time Time time editable true or false

Example: A wire lock's (Default value is true.)
begin time/end time
displaywhat One of the following:
ControlTimeInput.HMSD
ControlTimeInput.HMS
ControlTimeInput.MSD
ControlTimeInput.HM
ControlTimeInput.SD
ControlTimeInput.MS
ControlTimeInput.H
ControlTimeInput.M
ControlTimeInput.S
ControlTimeInput.D
where H=hour, M=minutes,
S=seconds, D=milliseconds
(Default value is
ControlTimeInput. HMSD.)

© 2008 Automated Logic Corporation 22

To display a... Data must be..
Control Parameter Parameter value
Timer Unsigned numbers minsec editable true or false
used as a timer (Default value is true.)
Example: A duty cycle's
time scalingfactor any floating point number
Multiplies the actual value except 0
by the scalingfactor value. (Default value is 1.)
Example: To convert watts
to kilowatts, use .001 as
the scalingfactor value.
showhours true or false
(Default value is false.)
showseconds true or false
(Default value is true.)

Simulating a control program

In simulation mode, you can specify microblock properties and define an operating environment to see
how a control program will operate.
To simulate a control program:
1 Select Control Program > Simulate.
2 In the Simulator window, select Options > Setup.
3 Define the simulation conditions. See table below.
4 Do one of the following:

○ Click to run the simulation continuously until you click to stop it. Set the Time
Increment fields (see table below) to define how fast the simulation will run.
○ Click to run the simulation one step at a time.
○ Click to run the simulation as fast as possible.
5 Click a microblock, then select its Simulation tab to enter values that will help you check the
programming. See NOTES below.
6 Verify that the logic performs the desired sequence of operation.
7 Close the simulation window to return to the workspace.

Field Notes
Calendar Enter the starting Time and Date for the simulation.
Communications Check Communications Ok to simulate normal communication. Uncheck this
field to simulate lost communication.

© 2008 Automated Logic Corporation 23

 Field Notes
Time Increment The Step Every value determines how often the simulation recalculates values
in real time.
The One Step = value determines how much simulation time passes between
each step.
For example, to see 30 minutes of simulation in 1 second of real time, use the
following settings:
○ Step Every 00:01 (mm:ss)
○ One Step = 30:00 (mm:ss)

TIP Set your One Step = shorter than the shortest delay in your control
program to avoid stepping over the delay in the simulation.

NOTES
• For simulation only, decimal values smaller than hundredths are rounded to the nearest
hundredth. For example .025 is rounded to .03.
• The Simulator has the same options as the main EIKON® LogicBuilder workspace for locating
items in the control program. See:
To find a microblock or label (page 27)
To find identical labels (page 27)
To show a logical path (page 27)
To show a wire's source microblock (page 27)

• Hold the cursor over a wire or label to see its value.

© 2008 Automated Logic Corporation 24

EIKON® LogicBuilder productivity tools
Use the following features to work efficiently.

To create and use symbols

You can reuse a sequence of programming by exporting it to a .logicsymbol file that you can import into
other control programs.
You can add frequently-used symbols to your Favorites list and organize them for ease of use.

To export a symbol
1 Select the items in a control program that you want in the symbol.
2 Select Edit > Export Symbol.
3 Type a File Name. The application will attach the .logicsymbol file extension.
4 Select the Selected Items Only checkbox.
5 Click Ok.

To import a symbol
1 Open the control program you want to paste a symbol into.
2 Select Edit > Import Symbol.
3 Browse to the symbol, then double-click it.
4 Click in the workspace to place the symbol.

NOTE You can drag a symbol from Windows Explorer to the EIKON® LogicBuilder workspace. Select
multiple items to drag them simultaneously. Hold down Ctrl as you drag and drop the .logicsymbol into
the workspace to have it open as a separate file.

To add symbols to your Favorites list

1 Select the items in a control program that you want in the symbol.
2 Right-click one of the items, then select Add to Favorites.
3 Type a Name and a Description.
4 Click Ok.

To put a Favorites item in a control program

1 Click Favorites.
2 Select the name of the symbol.
3 Click in the workspace to place the symbol.

© 2008 Automated Logic Corporation 25

 To organize favorites
1 Select Favorites > Organize.
2 Use the buttons on the right to:
○ Add new favorite
○ Remove favorite
○ Edit favorite's name or description
○ Move up
○ Move down
○ Open selected favorite in main view for editing

To use EquipmentBuilder
You can use EquipmentBuilder to generate:
• An entire control program that is ready to edit or download
• The corresponding equipment graphic
• A BACview® file (if applicable to selected equipment)

1 Select File > EquipmentBuilder.

2 Select the Equipment.
3 Use the default Name or change it.
4 Click Next.
5 Define values for the items on the following tabs:
○ Summary
○ Points
○ Sequence
6 Click Next.
7 Select the types of files you want EquipmentBuilder to generate.
8 Click Finish.

NOTE The files you selected will open in the EIKON® LogicBuilder and ViewBuilder applications.

To compare properties of multiple microblocks

1 Shift+click multiple microblocks to select them.
2 Right-click 1 of the microblocks, then select Compare Properties.
3 View and edit the properties that are common to all of the microblocks.
TIP Drag the right side of the window to expand the view.

© 2008 Automated Logic Corporation 26

To find a microblock or label
1 Select Edit > Find.
2 Enter the text you are looking for in the Find What field.
3 Select Case Sensitive if you want to find items that exactly match the uppercase or lowercase text
you typed in step 2.
4 Select the type of items you want to find in the Search box.
5 Click Find.
6 Select an item in the Found Items list. That item is highlighted.
7 Click Close.

To find identical labels

1 Right-click a label.
2 Select Find Label Usages.
3 Click an item in the list. That label is highlighted in the workspace.
4 Click Close.

To show a logical path

Right-click a wire, then select Highlight Connections.
If you leave the Highlight Connection box open while you highlight additional wires, each wire is
highlighted with a different color. Click Change Color to select a different color for the highlight.
Click Clear Highlight to turn off the highlighting.

To show a wire's source microblock

1 Right-click a wire.
2 Select Go To Source.

© 2008 Automated Logic Corporation 27

To use custom alarm and schedule categories
A WebCTRL® system has pre-defined alarm and schedule categories. But, you can add custom
categories. To do this, you add the custom category in the EIKON® LogicBuilder application, then add
the same category in the WebCTRL® interface. See "Using schedule categories" and "Customizing
alarms" in WebCTRL® Help.

To add a custom category in EIKON® LogicBuilder

1 Select Options > Preferences.
2 On the Alarm/Schedule Categories tab, select the Alarm Category tab or one of the following
Sched. Category tabs.

To create a schedule category

for this type of microblock... Select this tab
BACnet Time Clock Time Clock Sched. Category
BACnet Time Clock with TLO
Multi-state BACnet Time Clock Multi-state Time Clock Sched. Category
BACnet Modeled Schedule Modeled Schedule Sched. Category

3 Click .
4 Type the category name.
NOTES
○ This name must be identical to the reference name that you give the category when you add it
in the WebCTRL® interface.
○ Do not use occupancy as the category name.
○ The name can contain lowercase letters, numbers, hyphens, and underscores (no spaces); it
cannot begin with a number.
5 Click OK twice.
The new category will now appear in a microblock's Category droplist.

NOTES
• Do not delete the existing categories on the Sched. Category tabs if your system uses any control
programs created in EIKON® for WebCTRL. See Working with control programs created in EIKON®
for WebCTRL (page 30).
• To copy all custom category information to another computer, click Export below the category tabs,
then save the file. On the other computer, click Import, then select the exported file.

© 2008 Automated Logic Corporation 28

Miscellaneous EIKON® LogicBuilder menu commands

Menu command Notes

Control Program > Bundled When making a control program for use in a non-English system,
Resources use this command to embed the translation files in the control
program, omitting the need to maintain separate files. See
“Setting up your system for non-English languages” in WebCTRL®
Help.
Options > Preferences These apply to the EIKON® LogicBuilder application, not just the
current file.
On this tab... You can...
General • Set the metric option as the default for all
future control programs. See To begin a
control program. (page 8)
• Guarantee that all control program file
names do not contain spaces.
Alarm/Schedule • Add custom alarm or schedule categories.
Categories See To use custom alarm and schedule
categories (page 28).
• Import custom alarm templates, alarm
categories, or schedule categories from
the ems.ini file used by control programs
created in EIKON® for WebCTRL. See
Working with EIKON® for WebCTRL
control programs (page 30).
Droplist Options Customize the following droplists in certain
microblocks:
• BACNET Engineering Units (Airflow, AO, AI)
• Output types (AO)
• Actuator types (AO)
• Input types (AI)
• Sensor types (AI)
HTML Viewer Edit the location of your HTML Viewer.
Tools > Configure Use this command if directed by Technical Support to install an
added EIKON® LogicBuilder feature.
Window Select another currently open file to view or edit.
Help > Tip of the Day Clear the Show tips on startup checkbox if you don't want to see
the tips when you start the EIKON® LogicBuilder application.
Help > Apply Update Use this command to install WebCTRL® service packs or patches.
Help > About Technical support may ask you for this version, license, or Java
VM information.

© 2008 Automated Logic Corporation 29

Working with control programs created in the EIKON® for WebCTRL application
Some functionality of a WebCTRL® Logic page (for example, jumping to labels) requires that the
control program be an EIKON® LogicBuilder .equipment file.
To quickly upgrade multiple EIKON® for WebCTRL .equipment files to EIKON® LogicBuilder .equipment
files, see "Upgrading EIKON® for WebCTRL .equipment files" below.
To edit an EIKON® for WebCTRL control program in the EIKON® LogicBuilder application, you can
import the .eiw file or open the .equipment file. See "Editing EIKON® for WebCTRL control programs"
below.

IMPORTANT If you used custom schedule categories, alarm categories, or alarm templates in the
EIKON® for WebCTRL application, you must import them into the EIKON® LogicBuilder application
before you upgrade or edit the EIKON® for WebCTRL files.

Upgrading EIKON® for WebCTRL .equipment files

To quickly upgrade EIKON® for WebCTRL .equipment files to EIKON® LogicBuilder files:
1 In the EIKON® LogicBuilder application, select Tools > Convert EIKON for WebCTRL Equipment.
2 Browse to the folder containing the EIKON® for WebCTRL .equipment files, then click Open.
NOTE Before the upgrade takes place, all the control programs in the selected folder are copied to a
new backup folder.

Editing EIKON® for WebCTRL control programs

To edit an EIKON® for WebCTRL control program, you can open the .equipment file or import the .eiw
file. After editing, you will save the control program only as a .equipment file; the EIKON® LogicBuilder
application does not use a .eiw file.
To import a .eiw file:
1 Select File > Import from EIKON for WebCTRL.
2 Select the file you want to import, then click Open.
NOTE After you edit a .eiw file, consider doing one of the following to prevent using it as the starting
point for future control program edits.
• Move the .eiw file to a folder named Obsolete.
• Add -obsolete to the .eiw file name.

To import custom categories and templates from the EIKON® for WebCTRL
application
If you used custom schedule categories, alarm categories, or alarm templates in the EIKON® for
WebCTRL application, you must import those custom items from the ems.ini file.

CAUTION Importing deletes any custom categories or templates that you may have defined in the
EIKON® LogicBuilder application.

© 2008 Automated Logic Corporation 30

 To import from the ems.ini file:
1 Select Options > Preferences.
2 On the Alarm/Schedule Categories tab, click Import from INI.
3 Open the ems.ini file located in your previous system's Eikon folder.
4 Click OK.
NOTE If needed for v2.0 or earlier alarms, you can add templates on the Alarm Template tab. V2.5 or
later alarms use the Universal template.

© 2008 Automated Logic Corporation 31

Index
K
A
keyboard shortcuts • 2
alarm categories • 28, 30
alarm templates • 30 L
B labels • 9, 27
Logic pages • 2
background color • 8
bundled resources • 28, 29 M
C metric • 2, 8
microblock properties • 14
category microblocks • 1, 2, 4, 8, 15, 25
alarm • 28
schedule • 4, 28 P
control modules • 4 properties • 1, 9, 14, 15
control programs • 1, 4, 8 Properties pages • 9, 15
Normal • 4, 8
simulating • 23 R
UNI • 5, 8 reorder items • 15
ZN • 6, 8
custom microblock • 13 S
D schedule
categories • 4, 28, 30
download • 1 service packs and patches • 29
drawing lines/shapes • 12 shortcuts, mouse and keyboard • 2
E simulate a control program • 23
EIKON for WebCTRL • 30 T
error indicator • 11 text • 16, 18
errors • 11 third-party BACnet addresses • 28
expressions • 15
W
F
wires • 9
finding items in SiteBuilder
finding items in EIKON® LogicBuilder •
27
font • 11
G
graphics • 14
H
highlight connections • 27
J
joints • 8

© 2008 Automated Logic Corporation 32