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 How to decode BACnet errors when they are encountered in the following products. 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 Documentation is unavailable for these errors when reviewing log files against any captures.  Resolution The error in log files is composed of two fields, BACnetErrorClass and BACnetErrorCode. The BACnet Error Class (BEC) field is made of the high 16 bits and the BACnet Error Code (BE) of the low 16 bits.  0x800 indicates the error class and error code are in Hexidecimal format. Error Class 0x8001, when remove 0x800, 1 decodes to Object Error Code 001f decodes to Unknown Object Therefore, the error code is Object_Unknown Object, where the device indicates it has no knowledge of the object, either it does not exist or the device does not have the expected program/database installed. For b3, it could be memory was wiped on power failure and needs to be reloaded. It could mean the expected application needs to be downloaded for other devices.   The following are a subset of BACnet errors defined in the specification. If you have questions or encounter ones not listed, please contact Product Support Services.   Error Class List High 16 bits of Error. See BACnet spec 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 Code List Low 16 bits of Error. See BACnet spec 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   Common BACnet errors you may see: Error Code Translation Notes 0x8000001e Device + timeout likely something is offline 0x8001001f Object + unknown object likely b3/AS memory was wiped in power fail 0x80020020 Property + unknown property   0x80020025 Property + value out of range likely writing 0 to a multistate object 0x80020028 Property + write access denied   0x8002002c Property + not cov property trying to subscribe to non COV object (i.e. schedule) 0x8002002e Property + invalid configuration data likely configured a change-of-value alarm on non-analog 0x80030000 Resources + out of memory   0x80050007 Services + inconsistent parameters   0x80050019 Services + operational problem   0x8005001D Services + service request denied   0x8005002B Services + COV subscription failed (0x5002B may show, not including the 0x800)   In Wireshark, using the display filter bacapp.type == 5 one will see errors dissected in the APDU packets in Decimal format. 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 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 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. 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 What are the basic steps when doing a conversion from TAC Vista to EcoStruxureware Buildning 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 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 make changes to RSTP the controller MUST be restarted. 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 properly per Configuring RSTP on a Managed Switch for SmartX IP Controllers 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 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. Configure the Root Bridge Switch (closest to Automation Server) settings first Then configure the additional Switches in order of increasing Bridge Priority. 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 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 so consult the documentation or contact the vendor or manufacturer to assist with configuration. 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), there may be limits on the size of each loop based on their site switch network configuration and architecture.   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 Fusion Fridays - Session 07 ​​​​ 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 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, restart, re-enable RSTP Mode, restart, and check again. If Firmware 3.02.01 is installed, please upgrade to 3.02.02. SmartX is now SpaceLogic.

Issue There is a need for a single Compatibility Matrix that shows EBO, PME, Energy Expert and relevant software versions all in the same location. Product Line EcoStruxure Building Operation, Other Environment EcoStruxure Energy Expert (formerly Power Manager) ETL tool Cause Energy Expert version compatibility information is currently available but is stored in many different places such as release notes and online documentation, rather than one single matrix. Resolution The full ETL for EBO compatibility matrix is shown in the following table. Energy Expert  PME EBO ETL Integration Utility .NET Framework Power Manager 1.0 7.2.3 1.6.1 3 1.0.14304.2 4.5 Power Manager 1.1 8 1.6.1  1.7.1 4.1 1.0.15306.1 4.5 Power Manager 1.2 8.1 1.6.1  1.7.1  1.8.1 4.3 2.1.16081.1 4.6 Power Manager 1.3 8.2 1.8.1 1.9.x  4.6 2.2.17056.2 4.6 Energy expert 2.0 9 2 5 3.0.18215.3 4.6 Energy expert 3.0 2020 3.0 3.1 6 3.1.19319.1 4.6 Not commercialized  - (n/a) 2021 3.2.3 6 Integrated - (n/a) 4.8 Not commercialised - (n/a) 2022 4.0.2/2022 6 Integrated - (n/a) 4.8   Great care must be taken when choosing the correct version of ETL to use when integrating Energy Expert and EBO, as there are actually two families of ETL in production.  One ETL designed and tested for PME use only and ETL for EBO designed and tested with an EBO Extract Task specifically for integrating the two systems. (For example, a version of ETL 4.7 exists, but this is not ETL for EBO and therefore does NOT contain an EBO Extract Task, even though it is a valid version of ETL for the Power Community)

Issue After configuring SSL certificates manually, having an incompatible Host Certificate and Key file can cause the import to EBO to fail. Product Line EcoStruxure Building Operation Environment Building Operation Enterprise Central Building Operation Enterprise Server Building Operation Automation Server Cause Host Certificate provides the public key for which the private key is paired. An unmatched Host Certificate and private key will cause the certificate import to fail. Resolution While managing certificates manually, it is recommended to check that the Host Certificate and Key files are a matching pair.   Using the provided Host Certificate (.pem) file and private key (.key or .prv) file Download OpenSSL v1.1.1 Light choosing the EXE file type and correct version (Win64 or Win32), as the latest version letter will be posted to Win32/Win64 OpenSSL Installer for Windows - Shining Light Productions (slproweb.com) or OpenSSL installed with EBO If using Shining Light installer, it is recommended to open command prompt from where certificates are stored on the desktop and substitute openssl with "C:\Program Files\OpenSSL-Win64\bin\openssl.exe". Working with certificate files on the Windows desktop ensures the user will have the correct permission to run the commands, unlike putting certificate files in the Program Files directory where openssl.exe resides. Open PowerShell or Command Prompt Obtain the host certificate md5 hash with this command: openssl x509 -noout -modulus -in filename.pem | openssl md5 Obtain the private key md5 hash using the command below. Use the correct command based on the key file file type openssl rsa -noout -modulus -in filename.prv | openssl md5 openssl rsa -noout -modulus -in filename.key | openssl md5   In this example, the Host Certificate is HostCert.pem and the private key is EcoStruxure.key. The private key was converted to EcoStructure.prv using Step 12 of Installing an SSL Certificate from an External CA - Communities (se.com) These commands make the hash more readable to human eye. We use openssl to inspect the x509 for Certificate and encryption type rsa for the key to produce the modulus (-modulus), which is a long string. You then use (-noout) to prevent the full modulus from printing to the screen. You then create a shorter md5 hash so the human eye can easily compare them. If the md5 hashes match, that indicates that the modulus is a match and proves that the certificate/key is a pair.

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 Workstation error when logging into a remote Enterprise Server. Enterprise Server has available client licenses. 'No valid client license available. (Error -5: No such feature exists.)' Product Line EcoStruxure Building Operation Environment EcoStruxure Building Workstation  EcoStruxure Building Operation License Administrator Cause Workstation is trying to check out a license from the local computer. The License Server is on the Enterprise Server computer and the Enterprise Server license has been activated on the Enterprise Server computer.  Resolution On the Workstation computer, run the License Administrator and change the License server address from the default '@localhost' to the IP address of the Enterprise Server. Refer to License Server Address on Web Help. License server address default: Change to License Server IP address (example below):

Issue This condition will arise after successfully installing and running Project Configuration Tool for some time. PCT can no longer initialize the virtual host adapter as a result of the adapter being deleted or removed. The errors may be a result of but not limited to: Introducing a new VPN software package to your PC/Laptop. Manually removing or modifying the Virtual Box Host Only - Network Adapter. Malware or Antivirus platforms that have removed or disabled the adapter. Example: PCT Version - 1.1.2.57 Local mode was set up on a physical laptop and used to offline engineer a project. The job was completed and PCT was not used again for roughly a month. A new project was sold and required PCT for offline engineering. The laptop was booted up and PCT failed to open. The user was presented with the following errors: "Get System State Command: 'Could not connect' " "Get predefined properties command: 'Could not connect' " "GetDashboardErrors Command: 'Could not connect' " "Get System Memory info Command: 'Could not connect' " Product Line EcoStruxure Building Operation Environment Windows Client versions (64 Bit Only) Windows Server versions (64 Bit Only) PCT SERVER versions (64 Bit OS Only) SBO Project Configuration Tool - All versions Cause PCT can no longer initialize the virtual host adapter as a result of the Vbox adapter being deleted or removed. Resolution Reinstall PCT on top of your current installation. Your projects will not be modified in the process. Locate the installer. Run the installer, it will ask you to remove the previous version. Press ok. Progress will show as uninstalling. PCT will prompt for installation. Click Next. Select default installation paths. Click Next. Select desired PCT mode. Click next. Ready to Install selected mode. Click Next. PCT software installed. Click Finish. Now PCT will set up the Virtual Host Adapter. Press Ok. Status bar. Compted setup dialog. Click Ok. Run PCT. If successful you will see the template sets getting installed via the top right of the window. Open a project and test an AS/AS-P. If the above steps do not work, here are a few more to try:   Restart the machine after the PCT software finishes re-installing Right-click and select “Run as Administrator” Uninstall PCT software and Oracle VirtualBox and re-install once more   If PCT still will not work, please open a support case with your local Product Support Group.

Issue Support for OPC or DDE integration with EcoStruxure Building Operation Product Line EcoStruxure Building Operation Environment Building Operation Enterprise Server Building Operation Automation Server Premium Cause The OPC Server is a software program that converts hardware communication protocol into the OPC protocol. The OPC client software is any program that needs to connect to the hardware. The OPC client uses the OPC server to get data from or send commands to the hardware. Resolution Neither the OPC server nor the DDE configuration is supported at this time. There is not currently a roadmap for direct OPC client or server capability within the EcoStruxure Building Operation. To avoid problems with OPC Integration (and lose a project), there are two options for OPC integeration: It is possibe to use a converter to convert OPC to/from one of EBO supported protocols.  For example, use a 3rd party software to translate all the OPC points into BACnet Objects, “OPC Server -> BACnet Server”, or translate all EBO BACnet points to OPC. Perhaps one of the software programs below will be of benefit. Take into consideration what specifically will the ES be doing. If it is exchanging point values then it should work fine. Kepware Matrikon SCADA engine Note: These are 3rd party products that are not supported by Shneider Electric.    Use a SmartConnector Extension to be a middleware between EBO and OPC cilent or server. Check available extenstions at Exchange shop and SmartConnector Server and refer to EBO SmartDriver and Smart Connector KB article for more information.

Issue Unable to log into Workstation because the user password is unknown. 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 or Enterprise server/Central has been forgotten. Resolution IMPORTANT: The session ID is unique for this session of WorkStation. You cannot close WorkStation until the password has been reset. If you close WorkStation, before the password has been reset, a new session ID is generated that cannot be used with the temporary password provided by your local Schneider Electric Buildings support team.       The following are the steps to populate the session ID, which is required for doing the password reset.   For servers with EBO older than V3.1.X In the WorkStation logon page, while holding the shift key, left-click the area near the EcoStruxure Building Operations Icon.   This will populate the Session ID. Copy the Session ID.   For servers with EBO V3.1.X:   In Device Administrator, select the server you need to perform the reset to. Check the box and click the hyperlink   From the top bar select Password Reset Select OK when you get the “Password reset token created” pop-up Now, on the WorkStation logon page, while holding the shift key, left-click the area near the EcoStruxure Building Operations Icon. This will populate the Session ID. Click the Copy button.    For servers with EBO V3.2.X and higher In Device Administrator, select the server you need to perform the reset to From the top bar, select the “Edit Connection Password/Reset password” and press OK Now, on the WorkStation logon page, while holding the shift key, left-click the area near the EcoStruxure Building Operations Icon. This will populate the Session ID. Click the Copy button.   NOTE (for servers with EBO V3.1.X and higher)  For the Automation Server password reset, ensure that the Automation Server is connected to your PC machine via a USB cable. For the Enterprise server and Enterprise Central password reset, add the server to the Device Administrator using the “Add Server” button on the top bar. Please note even if you enter the wrong password, the Server would still be added to the Device Administrator.     After having the Session ID:   Send the Session ID to your local Schneider Electric Buildings support team Once PSS provides you with the unlock key In WorkStation, ensure that the Session ID is still visible, enter: User Name: admin Password: paste the result from the webpage Domain: Local and click Log On This will pop-up the Change-Password form Fill in the “old password” field with the unlock Key Put in a new password you want to use and then enter the new password in again. Click OK   NOTE:  When attempting to reset the password and unlock with the sessionid/temp password, you receive the error: "Your account has insufficient permission to use the system. Contact your administrator. "  Open a case with your local Product Support group and submit a request to unlock the user.   NOTE: WebHelp article 6749   The following video shows the password reset procedure for EBO older than V3.1.X. It covers most of the important steps for newer versions. Quick-Help video    

Issue Model and Device Name from SLP sensor via Modbus RTU Product Line EcoStruxure Building Operation Environment Automation Server AS, ASP, ASB SpaceLogic Sensor SLP Cause The Model, Device Name and Serial number are 64bit values and need to be collected with a single query to get the correct data. Script and Function Block programs can not manipulate 64 bit values - Model Register 9, 64bit, read only, Read Function Code 4 - Serial number Register 42, 64bit, read only, Read Function Code 4 - Device Name Register 7, 64bit, read/write, Read Function Code 3 (currently the documentation shows these as 32bit) Resolution A simple way to collect the Model and Serial Number is shown below This involves creating a Modbus Poll Group for the 4x 16bit parts of the 64bit Modbus Register. This will effectively query the 4 registers in a single packet, ensuring the correct data is collected. The same method can be used to collect the Device Name, but this value cannot be written using the same Group, as block/group write is not supported in EBO Create a Modbus Poll group containing the four 16bit registers, then create a String variable Then create a script to convert to ASCII characters

Issue When a Zigbee device is imported to EBO there is a lot of different configuration settings for the device, like the below settings for the Wiser Radiator Thermostat: How do I know what the different settings do? Do we have any documentation explaining that?  Product Line EcoStruxure Building Operation Environment Building Operation Automation Server Premium (AS-P) Building Operation Room Controller (RPC) Cause The different objects under the Zigbee device like "Thermostat" and "Power Configuration" is coming from something called clusters and a cluster is defined in the "Zigbee Cluster Library Specification". For example the "Remote sensing" attribute for the "Thermostat"   Look like this in the "Zigbee Cluster Library Specification" When joining a Zigbee device it will specify what cluster it support and that information is what will be used when building the import file which is imported to EBO. Resolution EBO doesn't know anything about the functionality of the Zigbee device. Instead it gets information from the device what clusters it supports, and will make sure the correct objects and attributes for the different clusters are created in EBO so it is possible to set all configuration parameters in the device. So to know what the different settings actually do in the device please contact the manufacturer of the device.

Issue How can I find out whether the EBO 2022 multi-version support applies to AS Classic module?  Does it apply to all the AS, AS-P, and AS-B modules? Product Line EcoStruxure Building Operation Environment Building Operation Enterprise Server Building Operation Automation Server Cause The EBO 2022 Release Note describes that the EBO 2022 Device Administrator software is not supported on the original AS classic (part number SXWAUTSVR10001) but there is no description of the software backward compatibility of the EBO on AS classic. Resolution An AS classic can continue to exist in a multi-version system; the maximum version an AS classic can operate at is 3.1.2. It is nowhere implied that it is not supported under a multi-version setup. The statement “EBO 2022 does not support AS classic” in the EBO 2022 Release Note is misunderstood. It simply means that one cannot install EBO 2022 on an AS Classic, the same as the previous EBO 3.2 version. Note that the AS Classic will not inherit any features introduced in later EBO releases when operating in a multi-version system.

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 At EBO 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 the list of supported features by each activation ID using the part number or license description through the Features and Licensed Products Table.  The Flexnet operation license portal is a public website 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 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 Automation Server does not have access to the Flexnet license activation server (no Internet connection), you can perform the offline activation of the embedded license. A shorter version of Online Activation of Embedded Licenses for Automation Servers is available here.

Issue When adding License Entitlements via Device Administrator using the online method. After clicking activate, a "Communication failed" message is displayed:   Could not establish contact with License Server using SmartX Server Followed by a "License Operation Failed" message:   Add entitlement failed. License Server is offline. Error code: 41 Error message: CURL error: Product Line EcoStruxure Building Operation Environment Device Administrator Building Operation Automation Server Premium Building Operation Automation Server Bundled Cause When activating a SmartX Server license online, the SmartX server will try to connect to the license activation server to activate the license. If it cannot resolve the license activation server site name and connect, it will show up as offline. Resolution Make sure that the SmartX Server DNS is properly configured in the AS-P.  In Device Administrator select the Ethernet 1 Configuration tab. Check the Primary, Secondary, and Tertiary DNS settings If unsure of the correct DNS address, enter the Google DNS address of 8.8.8.8 or 8.8.4.4. The example below shows a local router address as the Primary DNS and Google DNS as the Secondary and Tertiary DNS.   To confirm that the SmartX Server can resolve the license activation server address Open a Console session on the SmartX Server in Device Administrator. Enter the command: ping schneider-electric.flexnetoperations.com If the DNS is correctly set in the SmartX Server, the result should look similar to that shown below: Note: Ensure that the ASP is fully connected to the Internet in order to perform Online Embedded License Activation. You need to be connected to the Automation Server using IP (Not via USB) to activate the embedded license.

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 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    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 SXWSWESUP34010 ES Upgrade from 3.X to EBO 2022 with 10 or less AS Upgrade AS-P/B licensing from EBO 3 to EBO 4 These licenses need to be activated using Device Administrator.   For each AS-P one of the following bundles would be required for each AS-P.   SXWSWASPUP34SA Upgrades AS-P-XX from EBO 3.x to EBO 2022 AS-P Bundle – Standalone SXWSWASPUP34SD Upgrades AS-P-XX from EBO 3.x to EBO 2022 AS-P Bundle – Standard SXWSWASPUP34EN Upgrades AS-P-XX from EBO 3.x to EBO 2022 AS-P Bundle - Enhanced SXWSWASPUP34FU Upgrades AS-P-XX from EBO 3.x to EBO 2022 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. 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 “SXWSWASPUP34SD Upgrades an AS-P from EBO 3.x to EBO 2022 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.   For the AS-Bs one of the following bundles would be required for each AS-B. These licenses need to be activated using Device Administrator.   SXWSWASBUP34SD Upgrades AS-B from EBO 3.x to EBO 2022 AS-B Bundle – Standard SXWSWASBUP34FU Upgrades AS-B from EBO 3.x to EBO 2022 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 “SXWSWASBUP34SD 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 SXWSWASBUP34SD ASB Upgrade – Standard license is all that is required.   For the additional AS-P classic one of the following licenses would be required. SXWSWASPUP34SA Upgrades AS-P-XX from EBO 3.x to EBO 2022 AS-P Bundle – Standalone SXWSWASPUP34SD Upgrades AS-P-XX from EBO 3.x to EBO 2022 AS-P Bundle – Standard SXWSWASPUP34EN Upgrades AS-P-XX from EBO 3.x to EBO 2022 AS-P Bundle - Enhanced SXWSWASPUP34FU Upgrades AS-P-XX from EBO 3.x to EBO 2022 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. SXWSWASBUP34SD Upgrades AS-B from EBO 3.x to EBO 2022 AS-B Bundle – Standard SXWSWASBUP34FU Upgrades AS-B from EBO 3.x to EBO 2022 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, 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   SXWSWECUP34005 EC Upgrade from 3.x - with 5 or less ES SXWSWECUP34010 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 2022”   For information on software and features that require licenses  

Issue How to activate an embedded license for a SmartX Server using the Device Administrator when the computer with the Device Administrator is not connected to the internet. Product Line EcoStruxure Building Operation Environment Building Operation Automation Server Premium (AS-P) Cause Device Administrator is used to manage licenses on SmartX servers The following features of a SmartX server need licenses: SmartDrivers SNMP Notifications Personal Dashboards TimescaleDB MQTT Resolution Building Operation 2022 Note: The offline entry of the Activation-ID License items is not all visible - ONLY the first 5 are shown.  This makes entering this information impossible. This has been fixed in the Maintenance Release 4.0.2 of the Device Administrator.  After activating the embedded license offline and transferring this license to the servers, a license violation may be still shown.  The license status should update within 24 hours.  Perform a warm start and then a Refresh License Status on the selected servers to force this update.   If an error is seen in the progress status indicating ASEmbeddedAPI internal error during the offline activation, check the following Embedded license activation fails - Communities to correct the corrupted storage.   This video will show how to activate an embedded license for a SmartX Server using the Device Administrator when the computer with the Device Administrator and/or the server is not connected to the internet. IMPORTANT NOTES: You need to be connected to the SpaceLogic (SmartX) Server using IP (select +Add server on Device Administrator).  It cannot be connected via USB. Ensure always to run the Device Administrator with admin privileges. Select "Run as administrator." Should Device Administrator be running on a computer that has internet access, then there is no need to swap between online/offline computers.  The offline activation process can be run from the same Device Administrator with no need to change computers.  The offline workflow is always the same and detailed on the webhelp topic Offline Activation of Licenses Workflow  The video below shows version 3 licenses. In Version 4, there are a few more license features and quantities required to enter.  The following article may assist in entering this information. License Features list for version 3.0 and 4.0 Product names     At the end of the video session, you will be able to: Create a request file using the Device Administrator on an offline (to the Internet) computer. Activate request files from the Device Administrator on a PC connected to the internet. Send response files to the SmartX Server from the offline Device Administrator.

Issue How can EcoStruxure BMS server serve data to external devices or software? Product Line EcoStruxure Building Operation Environment EcoStruxure Building Operation Third party devices or software Cause The EcoStruxure Building Operation software supports the major communication protocols in building automation and security management. In many projects, it is required that an EcoStruxure BMS server serve data to external devices or software, E.X. HMI, SCADA or power monitoring. Resolution The following is a summary of the available options to serve EcoStruxure BMS server data to the external world: BACnet:  When you create a BACnet Interface, the system automatically creates the Application and IP network folders within the BACnet Interface folder on the System Tree. If you create a BACnet Interface for a SmartX server, you can optionally create an MS/TP network. You can create BACnet objects in BACnet application folder of EcoStruxure BMS servers and these object will be visible for external BACnet clients. More information about EBO BACnet interface: BACnet Interface   Modbus Slave network:  If you configure the Modbus Slave Network (and associate it with a serial port), you can set up any external Modbus master device to communicate with the internal Modbus Interface. In this example, a Modbus Slave Network is set up on an EcoStruxure BMS Server and the external master device is configured with the same Modbus properties as the Modbus Slave Network object. The Modbus master device can also be an HMI device. More information about Modbus serial interface: Modbus Serial Networks Modbus server network: You can create a Modbus TCP Network on an Ethernet network (TCP/IP).  You can create an internal interface which acts as the server to an external client/clients. More information about Modbus TCP interface: Client and Server Networks   MQTT: MQTT is a lightweight and flexible data transfer protocol for IoT resources. EcoStruxure Building Operation, V3.2 or higher, can be configured to send data to an MQTT broker on interval or event-driven. The below are the tested brokers: Microsoft Azure IoT Hub Amazon IoT Core IBM Watson IoT Mosquitto More information about MQTT interface: MQTT Overview LonWorks Interface: EcoStruxure BMS servers can have a local node on their networks that can act as a LonWorks node. In the local node, you can create your own NVs that can be bound to external LonWorks devices using LonWorks bindings. The NVs in your local node can then be used in EcoStruxure Building Operation bindings for applications and graphics. More information about LonWorks interface: LonWorks Engineering   SNMP: Simple Network Management Protocol (SNMP) is an Internet-standard protocol for managing devices on IP networks. The EcoStruxure BMS servers support SNMP version 3. The SmartX servers support several SNMP traps. SNMP traps enable an agent to notify the management station of significant events by way of an unsolicited SNMP message. More information about SNMP: SNMP EcoStruxure Web Service (EWS) server: EcoStruxure Web Services allows seamless sharing of operational data, including alarms and historical information, between software from different Schneider Electric Business Units. When the EcoStruxure BMS server is an EcoStruxure Web Service server, it exposes objects, such as values, to another EcoStruxure system that is an EcoStruxure Web Service client. The EcoStruxure Web Service client can read and change values on the EcoStruxure BMS depending on the configuration of the EcoStruxure BMS server. More information about EBO EWS Server: EcoStruxure Web Service Server Smart Connector: A development framework that simplifies and accelerates integrations with third-party systems or other data sources. It is an open, extensible and configurable application framework that allows developers to create innovative new capabilities, applications, and solutions which extend and enhance EcoStruxure Building solutions.   For further information watch the Smart Connector explainer video or visit the Smart Connector Developer Community on the Exchange: For developers wanting to get started using the Smart Connector framework visit: https://www.smartconnectorserver.com Smart Connector shop at Exchange:  https://shop.exchange.se.com/en-US/home