Issue Supplemental Documentation on the Menta/Function Block PID simple blocks Product Line TAC Vista, EcoStruxure Building Operation Environment Menta/Function Block editor Cause The document below is intended to clarify some of the more subtle aspects of the Menta/Function Block PID blocks and when/how to use them. Resolution A Brief Overview of PID Control Proportional-integral-derivative (PID) control is a generic feedback control loop algorithm. A PID controller calculates the error from the desired setpoint of a measured variable. It then adjusts the control output accordingly to try and minimize this error. Parameters used in the calculation must be tuned according to the system they are employed to control. The three prominent parameters are the proportional, integral, and derivative values. The proportional value affects the change in the output signal based upon the current error from setpoint. The integral value works based on the sum of the most recent errors. The derivative value reacts based on the rate at which the error has been changing. The weighted sum of these three actions is used to adjust the control output. The most typical application used in HVAC controls is actually a proportional-integral control with no derivative influence (PI). Derivative action is very sensitive to measurement noise, and generally considered too complex for the relatively limited benefit to slower, more easily controlled loops.   Three Types of PID Blocks in Menta Menta has three different simple blocks for PID control. They are: PIDI, PIDP, and PIDA (links to Web Help). PIDI PIDI is a PID controller with an incremental output. It is designed to be used together with two digital pulse output (DOPU) blocks in control loops with increase/decrease actuators. Input parameters to the PIDI will influence the operation of the controlled output in the same way as the analog PID blocks. The output, however, will not show a percentage. The end user will only be able to force an “open” or “close” command to the actuator – not set it to a desired percentage. Examples of how to use PIDI are explored later in the document. PIDP PIDP is the newer of the two analog output PID controllers in Menta. Because of this, it can only be used in Xenta controllers with a system program version of 3.6 or later. In Menta, under Options > Device Specification, it may be necessary to set the file to system version 3.6 or later during the programming phase. PIDP differs from PIDA in 4 distinct ways: PIDP will remain in saturation for a longer time than PIDA. The integral portion of the calculation keeps a running sum of previous error adjustments. Because of this, it can “wind up” a stored integral response. There is an anti-wind up mechanism to combat the effect, but PIDA has no wind up at all. In PIDP, a change in the setpoint value will not cause a step change when using PI or PID control. The measured error is not from the setpoint input, but rather from the last sampled measured value. The PID block samples a measured variable any time it is inside the deadzone. The allows for the calculation’s setpoint to equal the edge of the deadzone and have a less dramatic response to exiting the deadzone. The other time it will sample a new measured variable is any time a control coefficient is changed. This is an important distinction to be aware of during tuning operations. It may be useful to force the measured variable equal to setpoint after altering tuning parameters. The tracking of the tracking signal is not instantaneous in PIDP, as opposed to PIDA. Looping back the output to the TSg tracking signal feedback input will not cause the PID to stay synched with an overridden output. Additional logic is needed to switch the Mode to 0 for one program cycle in order to lock in the feedback signal any time it does not equal the output signal. The D-part is not as sensitive to measurement noise in PIDP as in PIDA. PIDA PIDA uses the following equation to calculate its output: where e is the control error, y is the measured value (MV), G is the controller Gain, Ti is the integral time, Td is the derivative time and h is the Control Interval (ControlInt), i.e. the time between two successive updates of the controller output signal. While analyzing and understanding this formula is beneficial to fully understanding the PID simple block, do not get too mired in the details. This document will help to demystify input parameters to make the PID work in a number of situations. For the purpose of this document, a PIDA will be assumed for all applications.   Inputs to the PIDA Block MV Measured value is the process variable for the PID controller. It is an input value of type Real. Examples of this would be a room temperature, a return air CO2 level, or a hot water differential pressure. SP Setpoint is the desired value of the measured value. It is an input value of type Real. It could be a static value (Operator “Real const”), adjustable from the front end (Simple Block “PVR”), a stepping value, or a modulating value. If the setpoint is likely to change often, it is recommended to use the PIDA block as opposed to PIDP. Mod The mode input to the PID block will control its action and enable or disable the control output. It is an input value of type Integer. There are four possible modes: Mode = 0 Web Help lists this mode as, “Off, controller stopped.” A more accurate description would be, “The value present at the TSg input will pass through to the output.” If the looped back output value is not changing, then the PID output will freeze. Mode = 1 Normal control. A new output value will be calculated on every Control Interval. Mode = 2 Controller output forced to UMax. This could be used on a hot water valve when freeze protection is enabled. Mode = 3 Controller output forced to UMin. This typically represents the “off” position of a PID. G Gain is the proportional parameter of the PID control. It is an input value of type Real. It is represented by the following equation: To arrive at an appropriate default value for Gain, three parameters must be considered: UMax, UMin, and proportional band. In typical applications, UMin and UMax will be 0% and 100%, respectively. This is because most valve or damper actuators are going to control between 0-100%. For the following examples, this will be assumed, but do not discount the effect it will have on default Gain parameters if these values change (such as in a cascade control application). Appropriate default parameters are merely in the same mathematical order of magnitude as the final tuned value. Rarely will the default parameter result in perfect operation of the control loop. It is only intended to get close enough to provide decently steady control until proper tuning can take place. It is usually easier to think in terms of proportional band than proportional Gain. Consider a room temperature. What would be an appropriate band around the setpoint to maintain? Perhaps ±5°F. If ±5°F is selected, that would result in a 10°F proportional band. Plug that into the equation along with the assumed UMin and UMax values: This would result in a default Gain of 10. It is important to remember that Gain is a unit-less value. A Gain of 10 is neither large nor small – merely relative to the process variable and anticipated error from setpoint. Consider a PID controlling an outside air damper to maintain an outside air flow of 1000cfm. Would a proportional band of 10cfm make sense in this situation? Probably not. A more appropriate value might be a band of 500cfm. Plug this into the same equation as before: In the case of air flow control, because the process variable and anticipated error from setpoint are so much larger than in temperature control, a more appropriate default Gain would be 0.2. In a third situation, consider a PID controlling static air pressure in a supply duct by modulating a variable speed fan. A proportional band of 500”wc would not make sense. A band of 0.8”wc might be more appropriate. In the instance of static air pressure, a default Gain of 125 would be suitable. Comparing these three situations with Gains of 0.2, 10, and 125, they will all have relatively similar speeds in the control loop. Just by glancing at these values alone, it cannot be said that any of them are “bigger” or “faster” than the others without a more in depth mathematical analysis. In addition to the value of the Gain, the sign is also important. Positive values represent reverse acting PIDs like a hot water valve where the signal to the valve will decrease as the room temperature increases. Negative values represent direct acting PIDs like a chilled water valve where the signal to the valve will increase as the room temperature increases. To avoid confusion at the front end, and reduce the possibility that end users will accidentally reverse the action of a PID, it is best practice to always use a positive value PVR to represent the value of the Gain. Then use an Expression absolute value operator “ABS()” to remove any sign and apply a negative value when necessary. Using this method, the Gain from the front end will always appear as a positive value and no consideration for the proper action of the PID will need to be taken after the programming phase is complete. Ti Ti is the integral time, or the integral portion of the PID control. It is an input value of type Real. Adding integral control to a straight proportional algorithm helps to avoid “controlling to an offset.” It is theoretically possible that a chilled water valve at 40% is exactly the amount of chilled water required to maintain a supply air temperature of 58°F, even if the setpoint is 55°F. If the error in the signal never changes, then the proportional algorithm will not change the output signal. And an offset has been achieved and will now be maintained indefinitely. Integral time will eliminate this possibility. Every Control Interval that the temperature remains above the setpoint, integral control will add a little more to the control output. This will cause the measured variable to always approach the setpoint. Because this value does have units (seconds) it is possible to compare one integral time value to the next. Ti is inversely proportional to the integral effect in the formulation of the next control output. In general, the smaller the Ti value, the more integral control will affect the control output. A value of 50 seconds would have a very large impact on the output. A value of 2500 seconds would hardly affect the control output at all. The exception to this rule is that a value of 0 seconds will disable integral control. Typical default values fall anywhere between 250-1000 seconds. Some PID solutions may be susceptible to “integral wind up” where the internal calculation desires and integral response beyond the output limits. When the control signal reverses, the integral wind up must be reversed before the output sees the change. In the PIDA algorithm, integral wind up is not a concern. Td Derivative time is also measured in seconds and represents the D portion of the PID. It is an input value of type Real. Derivative control is generally considered too complex and sensitive to measurement noise to be of sufficient benefit to HVAC control. A Simple Block “PVR” set to a value of 0 seconds will disable derivative control, but allow the tuner to add derivative control if desired. DZ Dead zone refers to the amount above and below the desired setpoint that will result in no change to the control output. It is an input value of type Real. This differs from the concept of a proportional band in that it is not centered around the value. While a proportional band of 10°F represents ±5°F around setpoint, a dead zone of 10°F would represent ±10°F around setpoint. A dead zone is helpful to reduce “hunting” of the control output where it repeatedly rises and falls when a steady output would cause the control variable to steady out. Typical values depend on the process variable. For a supply air temperature, anywhere from 0.25°F to 0.5°F would suffice. For outside air flow, anywhere from 50cfm to 100cfm might be appropriate. In a supply air static pressure control loop, limiting the dead zone to 0.1”wc would suffice. TSg TSg is short for tracking signal. It is an input value of type Real. The internal equation uses this as the value of the previous control signal. It should be looped back to the PID from the output signal. This might be directly from the output of the PID, or it may be after some external logic. The TSg input can be used in another way as well. When the PID is in Mode 0, the TSg value passes directly through to the output signal. By setting the PID to Mode 0 for the first second of a control period, initial positions other than UMin or UMax can be achieved. It can also be used to keep a PID in synch with an output that has been overridden by the front end. If the PID is controlling a physical output AO, then the output of the AO should be looped back to the PID.   Configuration Parameters of the PIDA Block ControlInt The Control Interval represents the number of seconds in between each successive calculation of outputs. If this value is set to 0 seconds, then the Control Interval will match the cycle time of the application. The Control Interval should be thought of in terms of how long a change in the control output will take before the impact is realized on the measured variable. Consider three scenarios: Scenario 1: A variable speed drive modulates a pump speed to maintain chilled water differential pressure. Because water is incompressible, a change in the pump speed results in an almost immediate change in the pressure. A Control Interval of 1 second is appropriate in this scenario. Scenario 2: A chilled water valve modulates to maintain a supply air temperature setpoint. The supply air temperature sensor is a few feet down the duct from the chilled water coil. A PID controller moves the chilled water valve from 0% to 10%. How long will it take before the supply air temperature starts to fall? Granted, there are several X factors in this equation, but a good guess might be around 20 seconds. A Control Interval of 20 seconds is appropriate in this scenario. Scenario 3: A supply air temperature setpoint modulates to maintain a large auditorium's temperature setpoint in a classic cascade control configuration. A chilled water valve then modulates to maintain the supply air temperature setpoint. Room temperature dictates that the supply air temperature setpoint should drop from 60°F to 55°F. How long will it take before this change in setpoint causes the room temperature to fall? It may take a full minute, perhaps even several minutes before that change has an affect at the room temperature sensor. A Control Interval of 80 seconds, while seeming very slow, is perfectly appropriate here. Correctly configured Control Intervals will allow one change in position to have an effect on the measured variable before a second (or third, or fourth...) change is made. A proper Control Interval will stop the valve from overshooting unnecessarily. UMin UMin is the minimum possible output of a PID controller. In most applications (valve and damper actuators) this will be set to 0%. In the case of a cascade control supply air setpoint PID, it might be set to 50°F. If the hardware output has a minimum position (say on an outside air damper), it is best to accomplish this with secondary logic as opposed to using the PID UMin. Otherwise if the PID is made public to the front end, the user will never see this value drop to 0, even if the control output is at 0. UMax UMax is the maximum possible output of a PID controller. In most applications (valve and damper actuators) this will be set to 100%. In the case of a cascade control supply air setpoint PID, it might be set to 90°F. StrokeTime The name Stroke Time refers to the manufacturer specified stroke time of a physical actuator. By setting the PID to the same stroke time as the valve it is controlling, it is guaranteed not to “wind up” faster than it is possible for the valve to react. Whenever possible, set the stroke time to match the physical stroke time of the actuator it is controlling. However, stroke time can be thought of in another way. It is used to calculate DuMax, the maximum rate of change of the controller output during one Control Interval. In the case of a chilled water valve that modulates between 0% and 100% with a Control Interval of 20 seconds, see how a stroke time of 180 seconds affects the DuMax: A stroke time of 0 seconds will not limit the rate of change at all in the controller. Based on the error and the Gain, it could potentially jump the full 100% stroke at once. By setting the stroke time to 180 seconds, the amount that the control signal can move every 20 seconds is now limited to 11.11%. It is not proper practice to employ stroke time as a tuning mechanism of a PID. It should be set prior to and independent from the tuning process.   Output of a PIDA Block The output of a PIDA block will usually control a hardware output from a Xenta controller. Because of this, it is typically connected to a Menta Simple Block “AO.” In Function Block it may be output to an analog value or hardware output.   Output of a PIDI Block A PIDI controls a floating actuator using two Simple Block “DOPU” digital pulse outputs. The PIDI will output a value between -1 and 1, which the DOPU block converts into the appropriate pulse lengths. Inverting the decrease signal will pulse the actuator closed when the output of the PIDI is negative.   The downside to PIDI control is that there is no percentage value to report to the front end about the position of the actuator. This is why use of the PIDI is somewhat rare. The same control can be accomplished using a PIDA with some external logic to pulse the floating actuator open and closed. Using a “virtual feedback” signal to mathematically monitor the assumed position of the floating actuator allows the end-user to view a percentage open signal for the actuator. It also allows them to override the Not-Connected AO to a certain position and have the floating actuator travel to that position just as an analog output would. The following example converts a Not-Connected AO from a PIDA into pulse output DOs from the controller. Public Signals and Public Constants All of the parameters that go into the operation of a PID need to be considered when tuning its operation. Eventually, one will come to the question of what parameters need to be made available from the front end. While some thoughts might end up on the well-meaning, under-trained end-user who could potentially wreak havoc by adjusting values, it is more important to consider the startup technician. If a value is not public from the front end, then a download must be performed to make any changes to any values. By making every parameters public by default (and only selectively removing certain parameters during exceptions) less time will be spent in the field during start up. After the PIDs have been tuned, it is always possible to remove certain values from being public. The exceptions are UMin and UMax, which when controlling a valve or a damper are almost always 0% and 100%. If desired, these can usually be hard-coded into the PID with little consideration. However, they can also be made available from the front end with little or no ill effects. Floating, PID, or Cascade Control There are three main control loop algorithms to consider when programming. Which one best suits the application is really a factor of the control loop speed. Consider the three options: Floating Floating control (also called bump control) involves making small, measured adjustments to the control signal on specified intervals. This is usually the best option any time a variable speed drive is involved. This is because these drives typically control supply fan static pressure or hot/cold water pump differential pressure. Both of these are very fast control loops. A slight change in the speed of the drive results in an almost instantaneous change in the measured variable. Floating control reacts more gradually to these quick changes. It compares the measured variable to the setpoint, and if it is too high, it bumps the control signal down a little bit. If the measured variable is too low, it bumps the control signal up a little bit. PIDs can (and often have been) used successfully to control very fast control loops. However, they are typically tuned to closely resemble floating control – low Control Interval, very little proportional control, very high integral control. In the end, it may be easier for a technician to understand and adjust “1% every 5 seconds” than “a Gain of 125 and an integral time of 175 seconds.” The other advantage to floating control is its adaptability. When tuning a PID, it is tuned to one exact set of circumstances – a certain load on the building, a certain volume of piping, etc. If enough of those conditions change by enough, the PID can be sent into oscillations. Floating control will not be affected by these changes. Consider a PID tuned to control a chilled water pump, which maintains differential pressure during the winter when loads are low. During the summer, a manual valve is opened to provide cooling to the athletics storage shed that was unoccupied all winter. This will increase both the demand for cooling and the volume of the pipe. This could potentially render the PID useless. However, a floating control will not react any differently. It will simply increase and decrease the speed as needed. See an example of floating control: The downside to floating control is that there is no proportional control. It will not take a bigger step size when the error is high. To combat this, and especially to aid during startup of equipment, this floating control macro utilizes two different step sizes – one for when error is low, and one for when error is high. By setting the threshold sufficiently high, this will cause more rapid acceleration during startup, and then quickly revert back to normal control during normal operation. This same code will also work relatively well for any size or nature of supply fan or supply pump. Minor adjustment of the parameters may be needed, but it will give a very decent starting point. PID PID control is for control loops of moderate speed. It can be thought of as the "valves and dampers" control method. A chilled water valve modulating to control supply air temperature or a damper modulating to control outside air flow are two examples of when PID control is appropriate. It is a source of debate whether PID control is appropriate in different situations. Some attest that a PID loop can be tuned to accurately control in any situation, including those where this document recommends either floating or cascade control. While this is certainly true, just because a PID can be used, does not mean that it is always the most appropriate solution, or that it will continue to work even as conditions change. Cascade Control Cascade control is used in very slow control loops. It is called cascade because two PIDs are used in a cascading arrangement – the output of the first is the setpoint of the second. An example of when to use cascade control is to modulate a chilled water valve to maintain the space temperature in a very large gym or auditorium. A small change in the chilled water valve position could take a very long time to have an effect at the sensor. If a regular PID is used, it is likely that the PID will wind up all the way to 100% output before the sensor ever experiences the first adjustment's effect. Then it will stay at 100% until it over-cools the space and starts decreasing the call for cooling. The same thing will happen on the reverse side as it modulates all the way to 0% and under-cools the space. And the cycle will continue indefinitely. In this cascade configuration, the supply air temperature setpoint is modulated based on the room temperature and setpoint. The chilled water valve PID then maintains the supply temperature. This will allow control that is more accurate and prevent the oscillation sometimes seen by inappropriate use of a single PID.   Putting It Into Practice There are college courses devoted entirely to the subject of PID control. The subjects covered in this document have barely scratched the surface of the topic. The intent is to give the average Menta/Function Block programmer and field technician the information needed to get a system up and running in as little time as possible with the most satisfied customer possible. Understanding when and why to use PID control will increase accuracy and efficiency of control loops and decrease wasteful overshoot, hunting, and oscillation. Tuning efforts will also be accelerated when the default parameters only require minor tweaking instead of calculation and trial and error. Using the hints and tips suggested will allow not only for proper programming techniques, but also for creation of macro libraries that can be reused and shared to improve effectiveness across business units.

Issue Understanding how to decode BACnet error values found in EBO Trace/System Logs, Controllers, and Continuum devices when documentation for the error message is not readily available. Product Line EcoStruxure Building Operation, Andover Continuum, TAC IA Series Environment EBO Error Log Tool Continuum bCX4040 (BACnet) Continuum b3s Building Operation Multi-purpose Controller (MPC/V) Building Operation Room Controller (RPC/V) Building Operation IP-IO EBO Trace and System logs Cause BACnet error messages in logs use a combined 32‑bit value that includes: BACnetErrorClass (BEC) in the high 16 bits BACnetErrorCode (BE) in the low 16 bits Values often appear with 0x800 prefix indicating hexadecimal formatting. Without decoding, the error meaning is unclear. Example: 0x8001001F 0x10000 → Error Class = Object 0x001F → Error Code = Unknown Object Resolution Understanding the Error Structure A BACnet error value is formed as: 0x8 0 0 [ErrorClassHex] [ErrorCodeHex] High 16 bits Low 16 bits Remove the 0x800 prefix, if present. Convert high 16 bits to identify Error Class. Convert low 16 bits to identify Error Code. Common Interpretation Example Error: 0x8001001F Error Class: 1 → Object Error Code: 1F (31 decimal) → Unknown Object Meaning: Device does not recognize the object. Possible reasons include: Expected program/database not loaded Object deleted or missing b3 device memory wiped after power failure Error Classes (High 16 Bits) (From BACnet Specification Clause 18) May not include 0x8000. (Example: could be 0x5002B instead of 0x8005002B for COV subscription failed) Error Class Hex(0x800) Dec Notes device 0 0   object 1 1   property 2 2   resources 3 3   security 4 4   services 5 5   vt 6 6   proprietary     64 is the first available code for proprietary error classes client 7FFD   0x7FFD0000 Reject 7FFE   0x7FFE0000 (error code is BACnetReject) Abort 7FFF   0x7FFF0000 (error code is BACnetAbort)   Error Codes (Low 16 Bits) A subset of codes from BACnet Clause 18: Error Code Hex (0x) Dec other 0 0 authentication_failed 1 1 configuration_in_progress 2 2 device_busy 3 3 dynamic_creation_not_supported 4 4 file_access_denied 5 5 incompatible_security_levels 6 6 inconsistent_parameters 7 7 inconsistent_selection_criterion 8 8 invalid_data_type 9 9 invalid_file_access_method A 10 invalid_file_start_position B 11 invalid_operator_name C 12 invalid_parameter_data_type D 13 invalid_time_stamp E 14 key_generation_error F 15 missing_required_parameter 10 16 no_objects_of_specified_type 11 17 no_space_for_object 12 18 no_space_to_add_list_element 13 19 no_space_to_write_property 14 20 no_vt_sessions_available 15 21 property_is_not_a_list 16 22 object_deletion_not_permitted 17 23 object_identifier_already_exists 18 24 operational_problem 19 25 password_failure 1A 26 read_access_denied 1B 27 security_not_supported 1C 28 service_request_denied 1D 29 timeout 1E 30 unknown_object 1F 31 unknown_property 20 32 removed 21 33 unknown_vt_class 22 34 unknown_vt_session 23 35 unsupported_object_type 24 36 value_out_of_range 25 37 vt_session_already_closed 26 38 vt_session_termination_failure 27 39 write_access_denied 28 40 character_set_not_supported 29 41 invalid_array_index 2A 42 cov_subscription_failed 2B 43 not_cov_property 2C 44 optional_functionality_not_supported 2D 45 invalid_configuration_data 2E 46 datatype_not_supported 2F 47 duplicate_name 30 48 duplicate_object_id 31 49 property_is_not_an_array 32 50   Frequently Encountered Errors Hex Value Decoded Meaning Notes 0x8000001E Device + timeout Device offline or non‑responsive 0x8001001F Object + unknown object b3/AS memory wipe, missing database 0x80020020 Property + unknown property Invalid property reference 0x80020025 Property + value out of range Writing 0 to multi‑state object 0x80020028 Property + write access denied Permission issue 0x8002002C Property + not COV property Subscription attempted on non‑COV property 0x8002002E Property + invalid configuration data Often caused by invalid COV alarm config 0x80030000 Resources + out of memory Device resource exhaustion 0x80050007 Services + inconsistent parameters Parameter mismatch 0x80050019 Services + operational problem General service failure 0x8005001D Services + service request denied Device rejected request 0x8005002B / 0x5002B Services + COV subscription failed May appear without 0x800 prefix Wireshark Tip Use the filter: bacapp.type == 5 This displays APDU error packets with decoded Class and Error fields in decimal. In this example, the BACnet device returns an error for Device (0) and operational problem (25) when responding to a readPropertyMultiple.

Issue Upgrade path from version 1.0 to a current version Product Line EcoStruxure Building Operation Environment SmartStruxure Building Operation versions 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9 EcoStruxure Building Operation versions 2.0, 3.0, 3.1, 3.2, 3.3 (limited), 4.0, 5.0, 6.0 Cause Upgrade path from version 1.0 to current - version Important - The upgrade process is sequential, for example, 1.1 to 1.2 to 1.3 to 1.4 From v1.9, non-sequential upgrades are possible  The primary released versions were, Release Note Dates (approximate) 1.0.0.161   1.1.0.362 Dec 2011 1.2.0.767 July 2012 1.3.0.938 Nov 2012 1.3.0.10100 SP1   1.3.0.20011 SP2   1.4.0.4020 Sept 2013 1.4.1.68-73 Oct 2013 1.5.0.532 July 2014 1.6.0.250 (RC) Dec 2014 1.6.1.5000 Feb 2015 1.6.2.27 Maintenance Release Jun 2016 see TPA-SBO-16-0003 1.7.0.255 (RC) July 2015 1.7.1.89 Oct 2015 1.7.2.29 Maintenance Release Jun 2016 see TPA-SBO-16-0003 1.8.0.244 (RC) Mar 2016 1.8.1.79-87 Jun 2016  1.9.1.95 Apr 2017   1.9.2.45 Maintenance Release Oct 2017  - See release note 1.9.3.24 Maintenance Release April 2018  - See release note 1.9.4.29 Maintenance Release April 2019  - See release note 2.0.1.130 & 135 June 2018 (130(License, WS, Reports Server) 135 - Server (AS, ES, EC)) - See release note 2.0.2.67 Maintenance Release Sep 2018  - See release note 2.0.3.45 Maintenance Release Dec 2018  - See release note 2.0.4.83 Maintenance Release June 2019  - See release note 3.0.1.104 May 2019  - See release note 3.0.2.33 Maintenance Release July 2019  - See release note 3.0.3.11 Maintenance Release Aug 2019  - See release note 3.0.4.43 Maintenance Release Dec 2019  - See release note 3.1.1.312 Dec 2019  - See release note 3.1.2.29 Maintenance Release Mar 2020  - See release note 3.2.1.630 Aug 2020  - See release note 3.2.2.61 Maintenance Release Nov 2020  - See release note 3.2.3.59 Maintenance Release Mar 2021  - See release note 3.3.1.59L Limited distribution release Feb 2021 - intended for specific feature compatibility with some hardware or applications - See release note EBO 2022 (4.0.1.86) Dec 2021 - This version follows v3.x, and reflects a new naming convention focused on release year for clarity - See release note EBO 2022 (4.0.2.559 & 562) Maintenance Release Apr 2022 - WorkStation Hotfix and License Admin 4.0.2.562, others 4.0.2.559, see revised release note EBO 2022 (4.0.3.176) Maintenance Release Jul 2022 - See release note EBO 2023 (5.0.1.86) Dec 2022 - See release note EBO 2024 (6.0.1.93) Mar 2024 - See release note Resolution It is most important to read the Release Notes and System Upgrade Reference Guide for each version you are upgrading to, as there are some special notes that only apply to some installation types. Click Here for Release Notes Click Here for Upgrade documentation The Minimum upgrade path would be as below (See Release Notes for any special instruction) 1.0.0.161 1.1.0.362 See StruxureWare Building Operation v1.0 to v1.1 upgrade issues Appendix A 1.1.0.1225 See Appendix A 1.2.0.767 See Appendix A This version can be avoided by using 1.2.0.1412 if possible 1.2.0.2207 (Hotfix) Available from PSS See also Appendix A 1.3.0.938 See also Appendix A 1.3.0.10100 (SP1) (needed if runtime compatibility is required during upgrade) 1.4.0.4020 or 1.4.1.68 (Only needed if runtime compatibility is required during upgrade) See Upgrading Automation Servers from 1.3 to 1.4 1.5.0.532 1.6.1.5000 See Upgrade to 1.5.0 or 1.6.0 fails 1.7.1.89 1.8.1.87 See Product Announcement 00471 Pre-Upgrade LON Add-On 1.7.1 to 1.8.x 1.9.1.95 Possible to upgrade directly from v1.5, but carefully study the release notes and upgrade instructions Option to 1.9.2.45 Upgrade options more limited with this version, only from v1.7.2, see the release note Option to 1.9.3.24 Upgrade options more limited with this version, only from v1.7.2, see the release note Option to 1.9.4.29 Upgrade options more limited with this version, only from v1.7.2, see the release note 2.0.1.130/135 Possible to upgrade directly from v1.5, but carefully study the release notes and upgrade instructions. NOTE the new License structure for v2.0. 3.0.1.104 Possible to upgrade directly from v1.8, see the table in "System Upgrade Reference Guide" (3.0.1 System Upgrade Overview), but carefully study the release notes and upgrade instructions. NOTE the new Licenses for v3.0. 3.1.1.312 Possible to upgrade directly from v1.8 See Release notes and upgrade documents for full details 3.2.1.630 AS Classic not supported, Win 7 and Win server 2008 not supported 3.3.1.59L Limited distribution release - intended for specific feature compatibility with some hardware or applications, see release note for details. If you do not require the specific features outlined in this Release Notes, it is recommend installing EcoStruxure Building Operation 3.2.x instead EBO 2022 (4.0.1.86 and later) The following protocols, objects, and devices are not supported in EcoStruxure Building Operation 4.0 or higher: I/NET, Sigma, MicroNet, NETWORK 8000 ASD and LCM. A multi-version system supports I/NET, MicroNet, NETWORK 8000 ASD and LCM on automation servers and Sigma on an enterprise server, running an earlier version than 4.0. Report Server/WebReports is not supported in EcoStruxure Building Operation 4.0 or higher. See release notes for details. EBO 2023 (5.0.1.128 and later) New SpaceLogic and Easylogic Controller support, External Storage support for MS SQL, Some support for IPv6, BACnet protocol rev.16, Virtualized Automation Server - Edge Server added,   See release notes for details. EBO 2024 (6.0.1.93 and later) Added New Software Assurnace, Sustainability Pack, EBO Enterprise Server and Enterprise Central for Linux, OPC UA Client Support, Modbus2 Support, Visual Programming for Function Block, XLSX Report, and Touch Room Controller Support. See release notes for details. Appendix A - Upgrading from Specific 1.x Builds Upgrade from V1.0.0.XXXX to V1.3 (via V1.1 and V1.2) Upgrade from 1.0.0.XXXX to 1.1.0.1225 Upgrade from 1.1.0.1225 to 1.2.0.1412 (Do not use 1.2.0.767) Upgrade from 1.2.0.1412 to 1.3 Upgrade from V1.1.0.XXXX to V1.3 (via V1.2) Upgrade from 1.1.0.XXXX to 1.2.0.1412 (Do not use 1.2.0.767) Upgrade from 1.2.0.1412 to 1.3 Upgrade from V1.2.0.767 to V1.3 Apply hotfix 1.2.0.2207 Upgrade from 1.2.0.2207 to 1.3 NOTE: These hotfix builds are not available for download from the Extranet site, you will need to contact Product Support and request them

Issue BACnet/IP controllers are not configured in RSTP Mode by default, therefore must be configured during installation. Having RSTP Mode disabled by default allows one to connect BACnet/IP controllers to any switch, even with port security configured to detect BPDU packets and disable the port. Product Line EcoStruxure Building Operation, TAC IA Series Environment Multi-purpose Controller (MP-C) Multi-purpose VAV (MP-V) Room Controller IP-IO I/A Series N4 Jace8000 SmartX IP Driver for Niagara Cause RSTP protocol requires that controllers, switches, and network architecture are configured to ensure the protocol will operate as expected.  Resolution Setting RSTP Mode for BACnet/IP Controllers ALL devices in the RSTP loop MUST BE IN RSTP MODE to function properly. This is not a huge issue because during startup you can unplug 2nd side of the loop and it will function properly in a daisy chain. Ensure the SmartX Controllers are configured correctly Configuring BACnet/IP Controller Device Settings A factory or network reset returns the RSTP setting to Disabled. Important: Whenever you change RSTP settings, the controller MUST be WARM START. If you fail to perform this restart, the BACnet/IP controller will continue communicating using its previous RSTP settings. 'Activate IP Changes' does not affect RSTP mode. Ensure the switch is configured correctly per Configuring RSTP on a Managed Switch for SmartX IP Controllers. If asked to review this for a case, please provide PSS screenshots from the switch configuration page(s).  Bridge Priority = 4096 Hello Time = 2 sec Max Age = 40  (40 is the maximum value allowed by the protocol. Default is 20) Forward Delay = 21 sec Bridge Priority Considerations Change Bridge Priority by adding 4096 as switches get further away from AS. (8192, 12288, 16384, 20480, 24576, 28672) DO NOT set the priority as 32768 or higher because that is the built-in Bridge Priority of BACnet/IP Controllers. First, configure the Root Bridge Switch (closest to the Automation Server) settings. Then, configure the additional Switches in order of increasing Bridge Priority. {OPTIONAL}: Troubleshooting RSTP with Wireshark Plug in 2nd side of the RSTP Loop If all devices stay online, then it is working properly. Now test line breaks or controllers that are powered off. If all devices go offline and/or the switch LED is flashing rapidly, then go to RSTP Troubleshooting. Managed Switch Troubleshooting Consult the documentation or contact the vendor or manufacturer to assist with configuration for the items below. Ensure the switch is IEEE 802.1D - 2004 capable. BACnet/IP Controller Networking Term Definitions RSTP Ring mentions the Rapid Spanning Tree Protocol is specified in IEEE 802.1D - 2004. Ensure the firmware is up-to-date by contacting the vendor or manufacturer or downloading it from its website. Ensure ports not participating in RSTP are configured as Edge Port, Admin port, or have STP disabled. Nomenclature for those settings on your specific managed switch may vary. Adding BACnet/IP controllers to site-managed switches, work with Local IT to add these devices to their network. They will need to work with their switch vendor/manufacturer/support group to ensure the configuration of those switches because it could be more complex than changing the minimum recommended four settings above. Also, since RSTP Protocol is limited to Max Age = 40 (hops including site switches and BACnet/IP controllers), each loop's size may be limited based on their site switch network configuration and architecture.  Determined the proper configuration (or disable) for the following features. DHCP snooping Dynamic ARP inspection Denial-of-service (DOS) mitigations BPDU Guard BPDU Filter Energy-saving settings. Similar to Wake-on-LAN: the switch had minimal traffic, so ports entered power-saving mode. When they reactivated, the AS-P had already timed out, triggering a comm loss alarm. RSTP Troubleshooting Check each BACnet/IP Controller -> Diagnostics -> Device Report to confirm in RSTP Mode MANUAL CHECKOUT Double-click MP - Diagnostics Files - Device Report It will open in the default text editor Review the Device Settings section near the bottom. In firmware 1.00.0x, the report should report RSTP Mode: Enable In firmware 2.00.0x or higher, RSTP: Enabled and RSTP Status: Operational If it reports disabled, then perform Setting RSTP Mode for BACnet IP Controllers Step 1 until RSTP is working properly. USE SEARCH & EVENTS EBO 2.x MP Device IP and Settings.xml for EBO 2.0 as it only includes MP controllers EBO 3.x SmartX Device IP and Settings.xml for EBO 3.x or higher Import attached search USE RSTP STATUS GRAPHIC IN WEBSTATION MUST BE EBO 3.1 or higher which includes ClientAPI support Frontline Fridays Episode 02 - Rapid Spanning Tree Protocol (RSTP) Date: 2022-11-11 Mike Botens posted the following in the thread: RSTP Status TGML dated 2022-11-09 PDF of the presentation Fusion Fridays - Session 07 ​​​​ Date: 2020-05-28 The start of the video shows the graphics page in use RSTP Status.zip is downloaded via the link below the video. Extract the TGML and drop it on the AS to import. The suggestion is to store TGML directly under the AS to help with navigation in Webstation. bind Network to the BACnet/IP network with the BACnet/IP Controllers. (You may need a second TGML page if BACnet/IP controllers are on Primary and Secondary IP) Run from web browser via WebStation because utilizes ClientAPI KNOWN ISSUES Offline controllers that are scattered are NOT an RSTP issue. Check to see if there is a possible DHCP issue by verifying controllers are still at their AUTO-IP address (IP 169.254.nnn.nnnn Subnet Mask 255.255.0.0). RSTP communications issues affect the entire RSTP loop or one contiguous group of controllers. Factory Reset or controller replacement should leave one ethernet cable unplugged until configured for RSTP per these articles: Replace a BACnet/IP Controller in an RSTP Ring Network Workflow and MP Controller Reset Modes If BACnet/IP Controller Device Report OR RSTP Graphic reports RSTP Status: Changes Pending instead of RSTP Status: Operational, disable RSTP Mode, Warm Start, re-enable RSTP Mode, Warm Start, and check again. SmartX is now SpaceLogic. KNOWN ISSUES with Firmware affecting RSTP: If Firmware 3.02.01 is installed, please upgrade to 3.02.02. RSTP not performing as expected with Static IP addressing RSTP does not work well on RPC HW RPC-16-B HW revision 6

Issue Unable to log into WorkStation because the administrator password is unknown or forgotten. Product Line EcoStruxure Building Operation Environment Building Operation Workstation Building Operation Automation Server (AS, AS-P, or AS-B) Building Operation Enterprise Server Building Operation Enterprise Central Building Operation Project Configuration Tool (PCT) Cause The password for an Automation Server, Enterprise Server or Enterprise Central has been forgotten. A Session ID is required to generate an unlock key from Schneider Electric Support. Resolution Important Notes The Session ID is unique to the current WorkStation session. Do not close WorkStation until the password reset is completed. For Automation Servers, USB connection to the PC is required (EBO 3.1 and later). For Enterprise Server or Enterprise Central, the server must be added to Device Administrator (password is not validated at this step). 1. Retrieve the Session ID EBO versions earlier than 3.1.x Open the WorkStation logon screen. Hold Shift and left‑click near the EcoStruxure Building Operation icon.   The Session ID appears. Copy it. EBO 3.1.x Open Device Administrator and select the required server. Tick the checkbox and click the hyperlink. From the toolbar, select Password Reset. When "Password reset token created" appears, click OK. In WorkStation, hold Shift and left‑click near the EcoStruxure Building Operation icon. Copy the Session ID. EBO 3.2.x and higher In Device Administrator, select the server. From the top bar, choose Edit Connection Password / Reset password, then click OK. In WorkStation, hold Shift and left‑click near the EcoStruxure Building Operation icon. Copy the Session ID. PCT 2.x Start the PCT server. Left click the Server Menu.   Select Set password reset mode. In WorkStation, hold Shift and left‑click near the EcoStruxure Building Operation icon. Copy the Session ID. 2. Submit Session ID and Receive Unlock Key Send the Session ID to your local Schneider Electric Product Support team. When you receive the unlock key, proceed to password reset. 3. Reset the Password Ensure the Session ID is still displayed in WorkStation. Log in using: User name: admin Password: unlock key provided by Product Support Domain: Local The Change Password window appears. Enter: Old Password: unlock key New Password: your chosen password (entered twice) Click OK. Troubleshooting Error: "Your account has insufficient permission to use the system. Contact your administrator." This indicates the admin account is locked. Contact your local Product Support group to request an account unlock. Additional References EBO Webhelp Password Reset topic The SBO Password Reset Quick-Help video shows the password reset procedure for EBO versions older than V3.1.X. It covers most of the important steps for newer versions.

Issue Users may want to know how to perform the online activation of an embedded license  Product Line EcoStruxure Building Operation Environment Building Operation Automation Server Premium (AS-P) Building Operation Automation Server Bundled (AS-B) Cause From Building Operation 2022, the Automation Server (Classic/Secure boot AS-B or AS-P) and features like Smart Drivers, SNMP notifications, Personalized dashboards, TimescaleDB, MQTT Publish/Subscribe, Modbus, Serial MS/TP, ES Connection, Server I/O, Field Devices, SAML Authentication, Zoning, and BACnet IP require a license. Customers need to know how to activate their embedded licenses to enable these features. Resolution This video will demonstrate how to Find the list of supported features by each activation ID. Activate an embedded license on an Automation Server Verify the embedded license status via the Device Administrator, Workstation, and the Flexnet operation license portal. Notes Check each activation ID's supported features using the part number or license description through the Features and Licensed Products Table.  The Flexnet operation license portal is a public FlexNet Login (flexnetoperations.com) accessible from anywhere with an Internet connection.  The Automation Server and the PC running the Device Administrator must have outbound connectivity to the license activation server over the Internet. Check the resolution section of this article Could not establish contact with License Server using SmartX Server - Communities to verify if the Automation Server has access to the Flexnet license activation server. For troubleshooting, refer to Embedded license activation fails. Web helps:  Assigning Licenses and Activating Licenses Online. An Embedded DEMO license is available for temporary use during project engineering and installation until you know each device's specific licensing needs. Please visit How to activate a demo license on an Automation Server at EBO 2022. If the Automation Server does not have access to the Flexnet license activation server (no Internet connection), you can perform the steps in the following article Offline activation of embedded licenses.  Please take note that starting from Building Operation 2023 version 5.0.3 and higher, Automation Servers are no longer required to be connected to the Internet. The Device Administrator can access the internet and manage communication and license activation for the 'offline' Automation Servers.   A shorter version of the Online Activation of Embedded Licenses for Automation Servers-Digital Job Book (nampss.com). is available on the NAM PSS site. (Note: Registration for access to this site may be required.)  

Issue Licenses required to upgrade SBO/EBO to EBO 2022 v4.0.x Product Line EcoStruxure Building Operation Environment Building Operation Automation Server Premium - Secure boot Building Operation Automation Server Premium Building Operation Automation Server Bundled Building Operation Enterprise Server Cause Clarifying licensing upgrade requirements for EBO 2022 v4.0.x Resolution Example: Upgrading a site SBO 1.x or EBO 2.x to EBO 2022 v4.0.x or later directly. Site has an Enterprise Server (ES) the ES has 7x Automation servers AS-Ps and 2x AS-Bs attached. One AS-P has a Modbus interface, and 1 AS-B has a Modbus interface. Adding 1 additional AS-P classic (non-secure boot), 1x AS-P-S secure boot and 1 AS-B scalable. The SBO 1.x or EBO 2.x licenses need to be upgraded to EBO 3.x first. Upgrade ES licensing from SBO 1.x license to EBO 3.x.  These licenses need to be activated using License Administrator.   1 x SXWSWESUP13010 ES Upgrade from 1.X to 3.0 with 10 or less AS  Note: Upgrading ES from 1.x gives the ability to host the maximum quantity of field devices / controllers at the Enterprise Server (600). Also, when a system is upgraded from 1.x, it will be provided with an unlimited (bounded by the maximums stated in the Architectural Guidelines) client license for connections to the Enterprise Server that has been upgraded.   The following additional licenses are required for each AS-x when upgrading a site from SBO 1.x to EBO 3.x or upgrading a site from EBO 2.x that was originally installed at SBO 1.x and upgraded to EBO 2.x. These are not required if the site was originally installed at EBO 2.0 and upgrading to EBO 3.x. These licenses need to be activated using License Administrator.   7 x SXWSWASUP00001 license will be required one for each AS-P. 2 x SXWSWASUP00001 licenses will be required one for each AS-B.   Note: If the site has more than 24 AS-xs then part number SXWSWASUP00099 provides 999 licenses. EBO 3.2.x architectural guidelines allows a maximum of 250 AS-xs per ES.   Upgrade ES license from EBO 3 to EBO 4 This license needs to be activated using License Administrator.   1 x SXWSWESUP30010 ES Upgrade from 3.X to EBO 2022 or later (i.e. to the current EBO version) with 10 or less AS Upgrade AS-P/B licensing from EBO 3 to EBO 4 or later These licenses need to be activated using Device Administrator.   For each AS-P (non secure boot AS-P and AS-P-NL), one of the following bundles would be required for each AS-P.   SXWSWASPUP30SA Upgrades AS-P-XX from EBO 3.x to EBO 2022 or later AS-P Bundle – Standalone SXWSWASPUP30SD Upgrades AS-P-XX from EBO 3.x to EBO 2022 or later AS-P Bundle – Standard SXWSWASPUP30EN Upgrades AS-P-XX from EBO 3.x to EBO 2022 or later AS-P Bundle - Enhanced SXWSWASPUP30FU Upgrades AS-P-XX from EBO 3.x to EBO 2022 or later AS-P Bundle – Full SXWSWASPUP30BP Full Bulk pack for upgrading AS-P-XX from EBO 3.x to EBO 2022 or later, contains 125 pieces of SXWSWASPUP30FU. For the AS-P with the Modbus interface, an SXWSWX000MBRTU license is not needed as Modbus is grand-fathered for AS-P classics.   Note: Once an AS-P license is upgraded, there is no differentiation between AS-P Secure Boot and AS-P Non-Secure Boot (Classic):   If the “SXWSWASPUP30SD Upgrades an AS-P from EBO 3.x to EBO 2022 or later AS-P Bundle – Standard” license was purchased for an AS-P classic, and later it requires an enhanced or full license.   SXWSWXUP00SDEN ASP Bundle upgrade - Standard to Enhanced SXWSWXUP00SDFU ASP Bundle upgrade - Standard to Full Would need to be purchased.   If the “SXWSWASPUP30EN Upgrades an AS-P from EBO 3.x to EBO 2022 or later AS-P Bundle – Enhanced” license was purchased for an AS-P classic, and later it requires an  full license. SXWSWXUP00ENFU ASP Bundle upgrade - Enhanced to Full Would need to be purchased.   For the AS-Bs (AS-B-24, AS-B-24H, AS-B-36, and AS-B-36H), one of the following bundles would be required for each AS-B. These licenses need to be activated using Device Administrator.   SXWSWASBUP30SD Upgrades AS-B from EBO 3.x to EBO 2022 or later AS-B Bundle – Standard SXWSWASBUP30FU Upgrades AS-B from EBO 3.x to EBO 2022 or later AS-B Bundle - Full A SXWSWX000MBRTU Modbus license is not needed with AS-Bs Note: Once an AS-B license is upgraded, there is no differentiation between AS-B Scalable and AS-B (L) Non-Scalable (Classic): If the “SXWSWASBUP30SD Upgrades AS-B from EBO 3.x to EBO 2022 AS-B Bundle – Standard” license was purchased for an AS-B (L) classic, and later it requires a full license.   SXWSWXBBUPSDFU ASB Bundle upgrade - Standard to Full, would need to be purchased.   To upgrade the AS-B-L (classic) type, the SXWSWASBUP30SD ASB Upgrade – Standard license is all that is required.   For the additional AS-P classic one of the following licenses would be required. SXWSWASPUP30SA Upgrades AS-P-XX from EBO 3.x to EBO 2022 or later AS-P Bundle – Standalone SXWSWASPUP30SD Upgrades AS-P-XX from EBO 3.x to EBO 2022 or later AS-P Bundle – Standard SXWSWASPUP30EN Upgrades AS-P-XX from EBO 3.x to EBO 2022 or later AS-P Bundle - Enhanced SXWSWASPUP30FU Upgrades AS-P-XX from EBO 3.x to EBO 2022 or later AS-P Bundle – Full For the AS-P with the Modbus interface, an SXWSWX000MBRTU license is not needed as Modbus is grand-fathered for AS-P classics.   For the additional AS-P secure boot one of the following licenses would be required. SXWSWXBU0000SA ASP Bundle - Standalone  SXWSWXBU0000SD ASP Bundle – Standard  SXWSWXBU0000EN ASP Bundle – Enhanced  SXWSWXBU0000FU ASP Bundle - Full  For the AS-P secure boot if a Modbus interface is to be used the SXWSWX000MBRTU Modbus license would be required. For the additional AS-B Scalable one of the following licenses would be required. SXWSWXBBU010SD ASB Bundle – Standard SXWSWXBBU050FU ASB Bundle – Full A SXWSWX000MBRTU Modbus license is not needed with AS-B scalable. If an additional AS-B classic was added one of the following licenses would be required. SXWSWASBUP30SD Upgrades AS-B from EBO 3.x to EBO 2022 or later AS-B Bundle – Standard SXWSWASBUP30FU Upgrades AS-B from EBO 3.x to EBO 2022 or later AS-B Bundle - Full A SXWSWX000MBRTU Modbus license is not needed with AS-Bs     Addition: If the site had an Enterprise Central (EC) at EBO 2.0 and was upgrading to EBO 2022 v4.0.x or later, one of the following licenses would be required to upgrade to EBO 3.x first:   SXWSWECUP23005 EC Upgrade with 5 or less ES SXWSWECUP23010 EC Upgrade with 10 or less ES Then one of the following licenses would be require to upgrade from EBO 3.x to EBO 2022 v4.0.x or later:   SXWSWECUP30005 EC Upgrade from 3.x - with 5 or less ES SXWSWECUP30010 EC Upgrade from 3.x - with 10 or less ES   For more information on the bundles, search for 'software bundles" in the  “Part Numbers and Hardware/Software User Matrix – EBO 2024”   For information on software and features that require licenses  

Issue What are the basic steps when doing a conversion from TAC Vista to EcoStruxure Building Operation (EBO)? Product Line EcoStruxure Building Operation Environment Building Operation Enterprise Server Building Operation Automation Server Premium Vista Server Cause When doing a conversion from TAC Vista to EcoStruxure Building Operation (EBO), a tool called TAC Vista Conversion tool is used to build the EBO database using an export file from TAC Vista. Resolution This video shows a basic conversion of a TAC Vista database to EBO, and the steps that needs to be taken for a successful conversion.

Issue Cannot find documentation on how to use the new Graphic components release with EBO 2.0 Getting the following errors when previewing my graphic page: "Script error in function "onLoad" .... ReferenceError: "_firstRun" is not defined "Script error in function "onChange" ... ReferenceError: "_setVisuals" is not defined The component added to the graphic shows no binding label in the WorkStations edit bindings window Product Line EcoStruxure Building Operation. Environment Building Operation Graphic Editor 2.0 and above GlobalScripts V2.0.0262 and above Cause With the release of EBO 2.0, a set of new components/snippets have been released, which are different from those issued in earlier releases, although there is very little change visually. The scripting, in most cases but not all, has been removed from the components themselves and put into single scripts. This means we can take advantage of the functionality of the global script. This requires the user to set the UseGlobalScripts attribute to True within the TGML graphic editor, which can be on a per-graphic basis and ensures that existing graphics will still function. Once turned to True, all components with scripts and requirements for other global scripts to function correctly can function as designed. For example, the setpoint box requires global scripts to ensure units and decimal places are displayed as designed/required due to the scripts. There are also two binds available on the box, one for reading and one for writing. Both need to be bound to enable the component to function correctly.  The components are designed this way to allow use in BACnet, where it may require reading the resultant Value but Writing at a specific Priority. Without the scripts added to the graphic, the component cannot function. For further details/questions, refer to the following Community Posts, which also include the current PDF documentation: Help-with-an-EBO-2-0-component EcoStruxure-Building-Operation/Graphic-Component-Library-Rev-AB1-002-pdf NAM Standards Team TGML Component Library - Communities (se.com) This article provides the necessary steps required to enable and get these new components working and does not provide in-depth functionality. Resolution Within Graphics Editor, enable UseGlobalScripts. To do this: Select the -Tgml object shown in the Objects pane In the Properties pane Change the UseGlobalScripts from False to True In the Global Graphic Snippets: Drag the GlobalScripts V2.0.xxxx onto the -Tgml object.  GlobalScripts then appends as shown below. Note: This must be done before adding any components and ONLY once on each Graphic page. Add a Component by dragging it into the Design window. Example showing the Component: Analogue Single Line Text, 100W Add Snippets to allow the relevant Bindings to be added to this component.  To do this: Select the Snippets tab, Select Select Global Bind Snippets Drag the appropriate snippet onto the Component. EcoStruxure Analog Value bind snippet is added to the Analogue Value component Save the graphic Preview - no errors should appear.  If there are errors: Ensure that the scripts/components have been added in the correct order Ensure the correct Snippet has been added to the correct Component.  Refer to the Graphic-Component-Library-Rev-AB1-002-pdf documentation for the tested snippets/component combinations. Open WorkStation and Edit Bindings on the saved graphic page Note: The default binding name displayed View the graphic page   Example: Showing forced value      

Issue How to connect a SpaceLogic IP Controller via MSTP Product Line EcoStruxure Building Operation Environment Workstation Automation Server (ASP/ASB) Space Logic IP Controller RS-485 Adapter Cause Only certain SpaceLogic IP Controller models and versions support the new BACnet MSTP Adaptor and details are required on how to configure these controllers for BACnet MSTP. Resolution The following video will illustrate how to: Configure ASP/ASB for BACnet MSTP Communication. Configure a SpaceLogic IP Controller as a BACnet MSTP device. Discover the SpaceLogic IP Controller on the BACnet MSTP network. Things you need: Software EcoStruxure Building Operation Workstation 2022 Building Commission Application (available from Google Play, Apple Store, or Microsoft Store) Hardware ASP/ASB version 4.0 or higher RP controller (hardware version 10 ) RS-485 Adaptor (Isolating or Non-Isolating) RJ45 UTP Straight Through Cable (12"/300mm or less) Note: - if the RP controller does not show MSTP settings check the Space Logic IP controller firmware release notes and install firmware corresponding to the EBO version.  For example firmware versions 3 and below do not have settings for MSTP configuration. Before attempting to install a SpaceLogic controller on MSTP consult the following: Isolated RS-485 Adapter and Non-isolated RS-485 Adapter for SpaceLogic IP controller types supporting the RS-485 MSTP adapter RP-C BACnet MS/TP Support for RP models supporting BACnet MS/TP Installing an RS-485 Adapter for information on installing the BACnet MSTP adapter Connecting an Isolated RS-485 Adapter and Connecting a Non-isolated RS-485 Adapter for port usage and CAT 5 UTP connection cable Allocating Flexible Ports for additional considerations on port usage Enabling the BACnet/IP Controller to Communicate on an MS/TP Network Please see the video below:

Issue How to exchange EBO data via a SmartConnector enabled REST endpoint. Product Line EcoStruxure building Operation Environment Building Operation Enterprise Server Building Operation Enterprise Central Building Operation Automation Server Building Operation Automation Server Premium Building Operation Automation Server Bundled SmartConnector Cause Need to serve EBO data in a RESTful manner. Resolution The following video will illustrate how to: Create user account group and user with permissions required for web service client access. Enable the EcoStruxure Web Service server in the EBO server. Create and configure REST endpoint in SmartConnector framework. Use Swagger interface to review the API documentation. Test the Web service using a 3rd party testing tool. Things you need: Software EBO server with valid license (Enterprise Central, Enterprise Server or Automation server) EBO WorkStation. SmartConnector with valid license Tools SoapUI (to be used for testing)   For more information check "SmartConnector RESTful EWS Gateway" document at SmartConnector Server download center, and Troubleshooting Smart Connector SoapEwsRestProvider connection with EBO - Communities (se.com)

Issue How to perform the activation of an embedded demo license Product Line EcoStruxure Building Operation Environment Building Operation Automation Server Premium (AS-P) Cause The embedded demo License is a temporary license used for demonstration purposes, training, site engineering, when waiting on a permanent license order, or license support. This license file has a .Bin extension and can be downloaded from the EcoStruxure Exchange (ecoxpert.se.com) and is valid for a limited time (3 months). Resolution This video will demonstrate where to download, and how to activate an embedded demo license on an Automation Server using the Device Administrator.

Issue There is currently no summary KB article for all the data collection available in EBO systems. Product Line EcoStruxure Building Operation Environment Building Operation Enterprise Server Building Operation Enterprise Central Building Operation Workstation Building Operation Webstation Building Operation Automation Server Premium Building Operation Automation Server Bundled Cause Identified the need to review data from EBO to analyze performance or issues. Resolution Purposes for Data Collection Provide visual information about the issue Screenshots (from Windows Snip & Sketch or other tools) Video Capture or Mobile Device Video Device LEDs, provide any information about them and when they change. Provide information about your configuration/installation Network devices, including routers, switches, and any configuration you can provide BMS Routers Site Topology, including all devices included in the communications path Provide server (EC/ES/AS) XBK backup Configuration only is smaller and useful when investigating configuration, bindings, and/or programming All Data is larger and recommended when need to see trends or events to help investigate the issue's timeline. Provide any information to replicate the issue. Provide as specific as possible steps used to create that outcome Provide VERSIONS of ALL software, hardware, and protocols involved If submit any captures or logs, perform the following: Provide any steps performed in EBO during the capture or log with the date & time, so these events can be matched.   Servers (EC/ES/AS) Collect logs from an Automation Server Collect logs from the Enterprise Server and Enterprise Central Backing Up EcoStruxure BMS Servers Manually  (Configuration Only or All Data) Server Fieldbus Protocols Infinet: Gathering Trace Log information for the Infinet bus in EBO Lon: (Video included) Analyze Lon communication using trace log in EBO Modbus: Capture a Modbus trace log in EBO/SBO   Software EBO Webstation Collect EBO Webstation browser logs EBO Workstation Collect EBO Workstation logs EBO Project Configuration Tool (PCT) Collect log files from Project Configuration Tool (PCT) Windows Review the Windows Event Logs. What specifically happens when an error occurs? Follow this KB article to view and save the Windows Events: Viewing, Saving, Sharing Windows Event Logs for Troubleshooting Purposes Wireshark For extended period capturing, use this article to set up a Ring Buffer in Wireshark. Wireshark capture ring buffer for continuous capturing Hardware b3/Infinet Controller Collect log from a b3 or Infinet controller BACnet/IP Controller Workstation method - BACnet/IP Controller Diagnostics Building Commission method - Viewing and Exporting Diagnostic Files (WebHelp) or Viewing Diagnostic Files (YouTube)   Protocols & Electrical Interfaces Ethernet Capture any ethernet traffic, including IP: Using WireShark to analyse communications on an Ethernet network Capture Loopback (127.0.0.1) traffic between applications and/or servers running on the same host OS: How to capture localhost traffic with Wireshark to help troubleshoot EWS communication issues Lon Using Loytec LPA with SpaceLogic Server AS-P RS-485 Fieldbuses include BACnet MS/TP, I/Net, Infinet, Modbus RTU BACnet MSTP Capture Application - Communities (se.com) aka mstpcap.exe BACnet - PicoScope Basics Picoscope Configuration for Modbus RTU capturing and decoding Modbus RTU capturing in Wireshark

Issue While editing graphics, the editor may "freeze" if you open the script window for a script object. This is because the window was last opened on a screen that is now not connected Product Line EcoStruxure Building Operation Environment EBO Graphics Editor Cause The position of the script window is saved along with other settings in a file on the PC. When the window was last opened on an external monitor, the window is displayed in the same position afterwards, ie. outside the area visible when the monitor is not connected. Resolution Make sure the editor is closed and edit the file. Path:% LOCALAPPDATA% \ Schneider_Electric_Buildi \ SE.Graphics.Editor.exe_Url_ [guid] \ [version] \ user.config  - [guid] can for example be: 5r4uwcrxydhrpcwgbhkkrpgxknpckzw5  - [version] can be 3.2.0.44 At the bottom of the file is "ScriptEditorWindowLocation". Set the value to e.g. 0.0 and save.

Issue How do I setup and configure the database when using External log storage in EBO? Product Line EcoStruxure Building Operation Environment PostgreSQL TimescaleDB pgAdmin Building Operation Workstation Cause When using External log storage in EcoStruxure Building Operation(EBO) PostgreSQL server and TimescaleDB are installed on a computer where the trend log data and events should be stored. The database used for External Log storage needs to be setup and configured correctly. Resolution The EBO External Log Storage Installer tool available on the Community assists with installing and configuring the PostgreSQL server. But if you like to see how it is done manually please watch this video. The following steps are shown in the video: Create the database in the PostgreSQL server Create a user which will be used by EBO when it connects to the database Configure the database for use with EBO Configure EBO to be able to connect to the database  

Issue How can I troubleshoot a communication issue with the Modbus protocol Is there a log available within the AS or ES that shows the Modbus communication between Modbus devices Product Line EcoStruxure Building Operation Environment Building Operation Workstation Building Operation Automation Server Building Operation Enterprise Server Cause When troubleshooting Modbus issues in an AS or ES it can be helpful to see the communication between devices to help identify this issue. The trace log within both server types is available and is configured as described below in the resolution. Resolution Open Workstation and navigate to [AS/ES name]/System/Modules/Trace/Loggers/nsp/nsp.pin. Right-click "nsp.pin.modbus" and choose Properties. Under Level, change from "Information" to "Debug", then click ok. In EBO 7.0 and higher, "Debug" will report 1 line per transaction, where "Trace" will report 8 lines for the same transaction. In EBO 7.0 and higher, instead of logging all Modbus with "nsp.pin.modbus," you can log separately Modbus TCP and Modbus Serial using either "nsp.pin.modbus.CommunicationLayer.ModbusCommsLogger.Serial" or "nsp.pin.modbus.CommunicationLayer.ModbusCommsLogger.TCP" Let it run a few minutes. If there are some user input needed to recreate the Modbus issue, then perform these steps now. Retrieve the log by right-clicking [AS/ES name]/System/Modules/Trace/TraceSettings and choose Trace settings->Get trace log.  Save the log file. A useful tool available on the Community, the Modbus decoder can be used to assist in viewing/debugging the Modbus trace log file information saved in the previous step. Once debugging is complete remember to change log level back to "Information" (reverse of step 3). Note: If the ES or AS is reset, i.e. cold started or warm started, the log level will return to 'Information', so if further increased logging is required, the procedure will need to be repeated. Note2: From v6 (2024), adding the trace below can be helpful for Modbus RTU /[ASName]/System/Modules/Trace/Loggers/nsp/nsp.pin/nsp.pin.sport/nsp.pin.sport.DeviceRS485   Here is a video showing the above process. 

Issue Confusion over the thermistor type selection for an EBO Temperature Input object Product Line EcoStruxure Building Operation Environment Building Operation I/O Module Building Operation Automation Server Bundled Building Operation Multi-purpose Controller (MPC) Building Operation Room Controller (RPC) Building Operation IP-IO Cause The Thermistor type selection lists sensor "Types" I through V     This is confusing since, for example, the Continuum sensor is listed as 10k Type I but in manufacturers literature and temperature vs resistance tables is often referred to as 10k Type 3 Resolution The reference to Thermistor 10k Type in the selection list is an internal reference and not intended to refer to the types listed in manufacturers literature and temperature vs resistance tables. For reference the selections refer to the following sensor types:   Thermistor 10k Type I (Continuum) – Thermistor 10K4A1 also referred to as 10K Type 3 - SpaceLogic Sensors (as SLASXXX, SLAWXXX and SLABXXX), STx5xx Sensors (see HVAC Sensor catalog for details) Thermistor 10k Type II (I/NET) – Thermistor 10K2A1 Dale/Vishay - STx20x Sensors (see HVAC Sensor catalog for details) Thermistor 10k Type III (Satchwell) – Thermistor 10K3A1 (No Longer Applicable for Satchwell sensors) Thermistor 10k Linearized (Satchwell DxT - Type T) - STx6xx Sensors (see HVAC Sensor catalog for details) Thermistor 10k Type IV (FD) – Thermistor 10K4A1 type ‘G’ (U.S. Sensor) Thermistor 10k Type V (FD w/ 11k shunt ) – Thermistor 10K type ‘G’ (U.S. Sensor) with external 11k ohm shunt resistor installed Thermistor 1.8k (Xenta) – Thermistor type 1.8KA1 - STx1xx Sensors (see HVAC Sensor catalog for details) Thermistor 1k (Balco) – (not a thermistor) RTD, 1000 ohm Balco Thermistor 20k (Honeywell) – Thermistor 20K6A1 type H Thermistor 2.2k (Johnson Controls) – 2.2K3A1   Refer to the Temperature Sensor Resistance Charts Knowledge Base article for temperature vs resistance charts for these sensor types and others.

Issue During installation of hotfix for EBO you get a "Hotfix file signature validation" error saying that Device Administrator cannot verify the issuer of the file signature's certificate.   In older versions of Device Administrator you might get an alternative error message "Invalid hotfix file" saying that the file does not have a valid Schneider signature. Product Line EcoStruxure Building Operation Environment Building Operation Automation Server Building Operation Automation Server Premium Building Operation Automation Server Bundled Device Administrator Offline system Version 3.1 and later Cause EBO hotfixes for SmartX Server are signed with a certificate to ensure that only valid files can be used. This certificate must be validated before you can use a new PC to install a hotfix. If the PC has not had any internet connection while previously installing a hotfix or does not have an internet connection, the certificate cannot be validated and hotfix installation therefore fails. Resolution There are two solutions Solution 1 Connect your PC to the Internet and install the hotfix on a SmartX Server. The certificate is validated, and the PC can subsequently be used to install hotfixes on other SmartX Servers, even if you are offline. Solution 2 You can manually import certificates and CRL (Certificate Revocation List) Download and save the following files: http://s1.symcb.com/pca3-g5.crl http://sv.symcb.com/sv.crl If the above URL's are blocked by your browser please download them here or the attached ZIP file.  Start a command prompt (cmd.exe) as administrator. Browse to the folder where the files from step 1 are stored. Run the following commands: CertUtil -AddStore CA pca3-g5.crl CertUtil -AddStore CA sv.crl Export host, intermediate, and root certificates from the hotfix file. Install the 3 certificates with the default selection. Restart Device Administrator and install the hotfix. Video for step 5 and 6:     November 2025: Added Intermediate and Root Certificates for Global Sign. Root: GlobalSign Timestamping Root R45 Intermediate: GlobalSign R45 AATL TimeStamping Root CA 2021

Issue When logging into Workstation one of the following error codes is given.  Invalid returned data from license server system. (Error code: -12) Cannot connect to license server system. (Error code: -15) License server system does not support this feature (Error code: -18) The desired vendor daemon is down. (Error code: -97) Product Line EcoStruxure Building Operation Environment Workstation License Server Cause These type of issues are contributed to the License Server, Vender Daemon being down or not having a valid license for the application which is used. Here is a complete list of error codes Resolution If Workstation is installed on a different PC than the license server, refer to SmartStruxure Workstation or editors can't get license when using firewall (errors -15 or -96). If you get license error -18 refer to Error "Requested license is not available on the license Server" even though the license for the StruxureWare Building Operation is valid. Start by working through the troubleshooting steps below. In some cases the Building Operation License Server was unable to start due to antivirus programs on the computer.    Cannot connect to FlexNet License Admin Using your internet browser and go to localhost:8888. If you are unable to connect to this address then the License Server is not running.  Ensure that the Building Operation X.X License Server is running as a service. Right Click on the Computer icon on the desktop and click on manage. In the system tree on the left, go to Services and Applications > Services.  Scroll through the list and select Building Operation X.X License Server. Click start in the top left corner of the window. Some times the following Windows Error 1067 is given when trying to start the License Server. Note: In the past this error has been caused by antivirus software on the computer. In this situation the antivirus program had to be uninstalled in order to allow the License Server to start.    If the Building Operation License Server will not start then it may be due to another program using TCP port 8888. Use TCPView to search for programs running on local port 8888 and stop the other program.      Vendor Daemon is Down Note: If working with a 32 bit PC, replace "Program Files (x86)" with "Program Files" in the file paths below. Using your internet browser go to the address localhost:8888. Click on Administration in the top right corner of the screen and login with admin/admin (If logging in for the first time it will prompt you to change the password.  Click on the Vendor Daemon Configuration tab and then select the taclic daemon.  Verify that the path in the License File or Directory field matches the location of the taclic.lic file. The first half of the file path is C:\Program Files (x86)\Schneider Electric StruxureWare\Building Operation X.X\License Server\ followed by what is in the License File or Directory field. Verify that the taclic.exe is located in the path found in the Vendor Daemon Location field. The first half of the file path is C:\Program Files (x86)\Schneider Electric StruxureWare\Building Operation X.X\License Server\ followed by what is in the Vendor Daemon Location field. If changes were made then click Save and then Start.    Vendor Daemon is Down issue caused by ipv6 Cases have been seen where having ipv6 enabled on the same computer where the license server is running causes the Daemon is down error.  Often there will be entries in the license server logs that are similar to: 17:46:44 (demo) Lost connection to lmgrd, heartbeat timeout expired, exiting. 17:46:44 (demo) EXITING DUE TO SIGNAL 37 Exit reason 5 17:46:44 (demo) IN: "f1" user1@host1 (SHUTDOWN) 17:46:44 (lmgrd) demo exited with status 37 (Communications error) To confirm whether this is the issue ask the site if it is OK to disable ipv6 on the machine temporarily. In Windows control panel disable ipv6 Reboot the computer. In some cases, it might be needed to disable IPv6 completely in the registry: https://tweaks.com/windows/40099/how-to-properly-disable-ipv6/ If the issue is resolved then inquire with the site if it is OK to leave ipv6 disabled. If SIGNAL 37 errors are seen in the license server logs, these can be caused by having the localhost name associated with the IPv6 loopback address in the hosts file. This can cause communication problems between the license server daemon (lmgrd) and the vendor daemon, resulting in shutdown of the latter. If you have a line like the following in the /etc/hosts file: ::1 localhost ip6-localhost ip6-loopback please change it to ::1 localhost6 ip6-localhost ip6-loopback so that the localhost name is associated only with the IPv4 127.0.0.1 address. Please note that modifying this file requires Windows administrative privileges.  

Issue Does EcoStruxure Building Operation support virtualization?  Can the Enterprise and Reports server be on a virtual machine? Can EcoStruxure Building Operation be installed in cloud environments? Product Line EcoStruxure Building Operation Environment VMWare Hyper-V Microsoft Azure Amazon Web Services EcoStruxure Building Operation 2.0 through current release. Cause Desire for virtualization or cloud environment. Resolution Emulating environments Virtualization has several interpretations. In this article, we'll specifically address running EcoStruxure Building Management software in emulating environments like VMware or Hyper-V. These emulating environment software packages replicate a physical PC environment, allowing multiple computers to operate on a single machine, hence the term "virtualization". Several software vendors offer emulating systems, with VMware and Hyper-V being the most prominent. The advantages of running an emulating environment include reduced physical machines, minimized space requirements, and lower maintenance costs.   It's important to note that other potential meanings of "virtualization" such as remote desktop, remote control software, terminal server environment, or cluster environment are not covered in this article.   EcoStruxure Building Management in emulating environments Currently, numerous installations are running EcoStruxure Building Management on VMware and Hyper-V without significant issues. Some challenges have been observed related to Veeam setup, which doesn't seem to integrate seamlessly with ES (and possibly EC).   VMware is utilized internally in R&D and Product Support teams with positive feedback on its performance. Users should have familiarity with the emulating product to configure settings correctly, ensuring network functionality. It's important to highlight that no specific efforts have been made to develop EcoStruxure Building Management to comply with emulating environments. Additionally, there are no specific tests to verify its functionality in emulating environments. Certain issues have been seen with the License system used by EcoStruxure Building Operation when running on specific emulating environments due to limitations in the license system's support for these environments.   Support for EcoStruxure Building Management installations running in emulating environments Product Support provides support for EcoStruxure Building Management software, irrespective of whether it runs on PC hardware or in an emulating environment. Support is provided for problems related to the EcoStruxure Building Management Software itself, but not for issues related to the environment it runs on. Except for approved operating systems and minimum memory requirements, Product Support does not offer guidance on configuring specific PC hardware or emulating environments. Cloud environments Cloud computing environments such as Microsoft Azure and Amazon Web Services provide on-demand availability of computer system resources without direct active management by the user. Cloud computing relies on sharing of resources and typically uses a pay-as-you-go model, which can help in reducing capital expenses.   One of the challenges of cloud computing is reduced visibility and control. Cloud users may not have full insight into how their cloud resources are managed, configured, or optimized by their providers. They may also have limited ability to customize or modify their cloud services according to their specific needs or preferences.   Support for EcoStruxure Building Management installations in Cloud environments EcoStruxure Building Operation has not been developed or tested with Cloud environments in mind and it is therefore not currently a supported environment.