Helps_SV_V11_1 _ WORD FILES _ ENUSV_Application Architect

Application Architect Overview2Application Architect Terminology3Application Architect Methodology4Application Architect Settings5Templates Overview6How to Define a Template7How to Add Variables to a Template9How to Add Associated Behavior to a Variable11How to Add an Expression to a Variable14How to Add an Event to a Variable15How to Add Alarm Synthesis to a Variable17How to Add Cyclic Actions to a Template19Adding Parameters to a Template21Using Graphics with Templates22How to add a Mimic to a Template23How to add a Symbol to a Template26Using Tagging to Control the Instantiation of Symbols29Using Communication with Templates30How to Add SNMP Configuration to a Template31Included Templates34Inherited Templates37Differentiation Overview38Defining a Property by an Input39Using Properties Defined by an Expression41Defining a Property by a Parameter42How to Create a Global Parameter45Positioning a Global Parameter48Removing a Global Parameter51Using the Maintain Default Value Option52How to Enter an Expression53Application Architect Expression Function and Operator Reference56How the Value of an Input Parameter is Resolved59About Instantiation61Instantiating Templates62Adding Topology Elements65Managing Properties Defined by an Input, Expression or Parameter67Creating Exceptions69Locating the Original Template or Parameter72Generation74Keywords Example76Example of the use of Navigation Keywords79Example of the use of Property Keywords81Parameter Examples83Global Parameter Examples87Application Architect OverviewThe Application Architect is a tool to structure part or all of an application (project) by designing and instantiating templates. A template is a representation of a real world object in terms of the Supervisors configuration elements. Templates (and instances thereof) can include: Configuration elements Variables Bit Register Text Variablebehaviors Trends HDS Proprietary ODBC Free Event Program E-mail Expression Alarm synthesis Threshold Chronometer Counter Discrepancy Alarm behavior Acknowledgement transmission Program action Window action Masking by variable Masking by expression template Cyclic actions Communication SNMP Network Unmanaged device SNMP device Polling group Graphic elements Mimics Graphic symbolsA template can represent anything from a simple on-off switch to a complete process plant.The object oriented approach of templates encourages and helps the developer to structure applications in a way that makes modification and maintenance much easier and quicker. Templates can be stored in a library so they can be reused in many applications thereby significantly reducing configuration time. An application can be designed using a mix of configuration elements created by the Application Architect, the Application Explorer and Smart Generators. Configuration elements can even be created via the Application Architect and modified using the Application Explorer.Access to the Application Architect is affected by a users rights. See the book on User Accounts for further information.Application Architect TerminologyTemplateA template is a representation of a real world object (for example a pump or a HVAC unit) made up of the Supervisorss configuration elements.Inherited templateAn inherited template is a template that has another template as its parent. The same parent template can have any number of inherited templates. That is, there is a one to many relationship between parent and inherited templates. Included templateAn included template is an instance of a template that is embedded in another template. You can have one or more templates embedded in the same template. That is, there is a one to many relationship between the container template and its included templates. ParameterA parameter is a container for a value that can be used instead of a fixed value in any object property. For example you could create a parameter called pMaximum to be used for a register variables Maximum property. There are two types of parameter, Input and Expression. Input parameters contain a value. A default value can be entered for the parameter, or the value entered (input) when it is associated to a template. The same parameter can have different values each time it is used. Expression parameters contain an expression. The expression is evaluated when a template in which the parameter has been associated to is instantiated. Global parameterA global parameter is a container for a value that is used instead of a fixed value for a specific property type. There is a one to one relationship between each global parameter and a specific property type. For example you could create a global parameter called gServerList that is used whenever an object containing the property Server Station List is instantiated. There are two types of global parameter, Input and Expression.Topology elementA topology element is used to create additional structure (and hence variable branches) when instantiating templates. It could be considered as the instantiation of a template that is empty (has no configuration elements of its own).At any time, a topology element can be transformed into an instance of a template.CategoryA category is just a convenient way to organize templates and parameters. (Similar to using a folder to organize documents.) For example you could create a category called Lighting. Categories do not have any impact on the structure of the application.InstanceAn instance is an occurrence, some sort of a named copy of a template. When the Supervisors configuration is generated each instance will result in the production of one or more configuration elements (variables, symbols, mimics etc.). A template and its instances do have the same configuration elements attached to them, but potentially with different property values (see Differentiation).DifferentiationDifferentiation is the art of identifying and defining the properties whose values will differ from an instance to another instance of the same template. It is the name given to the process of using a parameter or an input, instead of a fixed value, for a property.Application Architect MethodologyThere are two generally accepted approaches to modeling known as top-down and bottom-up. Top-down - In a top-down approach an overview of the system is produced, defining first-level subsystems but not detailing base elements. Each subsystem is then refined in yet greater detail, usually by a breakdown in many additional subsystem levels, until the base elements of the entire system can be defined. Bottom-up - In a bottom-up approach the individual base elements of the system are first specified in great detail. These elements are then linked together to form larger subsystems, which then in turn are linked, sometimes in many levels, until a complete top-level system is formed. Whichever approach you choose the general procedure within the Application Architect will follow these steps: Identify templates. High level templates first corresponding to sub-systems if using a top-down approach. Base elements first if using a bottom-up approach. Identify parameters. Identify dependencies (instantiation rules, what is child of what). Define templates. Define global parameters. That is those that affect a big percentage of a particular property type. (Typically Station Lists, Network Name, Domain, Nature.). Associate global parameters with those templates for which they impact all instances. Define parameters. That is those that affect a smaller percentage of one or more properties. (For example the range (Max & Min) for all registers representing a temperature.) Associate parameters with templates. Differentiate properties by defining them by a global parameter, parameter, an expression or an input Create any topology elements. In particular, in a bottom-up approach, higher level subsystems that are not yet be identified / defined as templates. Instantiate templates. Associate global parameters with the elements of the topology to which they are relevant (tree, topology element, template instance included templates). Define parameters and inputs values. Generate. Refine by iteration.Application Architect SettingsThe Application Architects settings are displayed from the Application Architect entry from Configuration.Project.Parameters menu. Show picture Show generation option box - Show the Options dialog when generating the configuration elements. Consistency checking Allow blank branch - Allows an empty (blank) branch at instantiation.* Allow duplicate branch - Allows the use of duplicate branches within the same tree.* Allow recursive property - Allows one property to be used in the expression of another parameter. See below. Must also be enabled if a parameter or expression is used in the Description property of any of the elements. Type of synchronization Full synchronization - Uses full synchronization when generating the application. See the topic on Generation for details. Fast synchronization - Uses fast synchronization when generating the application. See the topic on Generation for details.* If you enable these settings it may result in the generation of duplicate variables.Allow recursive propertyThe Allow recursive property setting should be used with caution as it can cause an infinite loop during generation. This is best explained by two examples.Parameter01: =3 + 4Parameter02: =ParamsParameter01 + 7This can only be evaluated if Allow recursive property is enabled.Parameter01: = Params Parameter02 + 4 Parameter02: = Params Parameter01 + 7 This would cause an infinite loop if Allow recursive property is enabled.Templates OverviewTemplates are the building blocks of the Application Architect. The mechanism of identifying the necessary templates for an application is known as modeling. Templates can be saved in the Supervisors libraries so that they can be re-used in further applications. What is a template?A template is a model of a real world object (for example a pump or a HVAC unit) made up of the Supervisorss configuration elements.A template can contain the following configuration elements: Parameters - Named parameters, containing either an expression or a value. Included templates. Variables - Only the final part (leaf) of the variable name is specified, the remaining branches coming from the topology of the template instantiation. Variables can include trends, events, thresholds, alarm synthesis. Mimics - The name of the mimic that will contain any symbols that are instantiated. Symbols - Representing the template, and requiring instantiation in a mimic of higher level. Communication - SNMP Network, Devices and Polling Groups.Inherited templateAn inherited template is one that has another template as its parent. The same parent template can have any number of inherited templates. That is, there is a one to many relationship between parent and inherited templates. When the inherited template is instantiated, the instance will contain both its elements, and those of the parent template (if the parent template is instantiated it contains only its own elements).Example - The LIGHT template has one variable called STATUS. The DIMMER LIGHT template has one variable called LUX and is inherited from the LIGHT template. When the DIMMER LIGHT template is instantiated, the instance will have both the STATUS and LUX variables.The concept of inheritance allows the definition of one or more specialized templates sharing a common base. Included templateAn included template is an instance of a template that is embedded in another template. You can have one or more templates embedded in the same template. That is, there is a many to one relationship between the included and container templates. When the container template is instantiated it has both its own elements plus those of its embedded templates (if the embedded template is instantiated it contains only its own elements).The concept of inclusion can produce complex templates by aggregating much simpler ones (like building bricks). Example - The OFFICE template has one variable called TEMPERATURE. The LIGHT template has one variable called STATUS. The OFFICE template includes four (embedded) instantiations of the LIGHT template (LIGHT_1, LIGHT_2 etc.). When the OFFICE template is instantiated it will contain one TEMPERATURE variable plus four instances of the STATUS variable (LIGHT_1.STATUS, LIGHT_2.STATUS etc.).How to Define a Template1. In the right-hand pane of the Application Architect, select the Templates tab.2. Using the templates configuration tree select the library and/or category in which the template will be saved. (A category is always subordinate to one of the libraries.)3. Select Add a template. A new template with a default name is created.4. Edit the name to one appropriate to your application. You can either edit the name directly by clicking on it in the configuration trees or edit it in the Name field in the properties grid. The name of a template must be unique within a library (even if it is in a separate category).Show picture5. Add a description using the Description field in the properties grid. The description is optional.6. Configure the other properties (see below).The name of the template is for reference only and does not effect the structure of the generated application.About the Can be instantiated propertyIf Can be instantiated is set to No there are several effects. The template cannot be directly instantiated although it can still be included in another template which can be instantiated. It does not appear in the menu or toolbars when adding an instance. Where the template has been configured with inherited templates, it does appear in the menus and toolbars but is dimmed and cannot be selected. Show pictureUsing the automatic naming propertiesThe Automatic Naming Properties can be used to modify the naming process when instantiating the template. For example using the automatic properties configured as follows: Instance base name - LUMINAIRE Start value - 100 Fixed digits - 3 Step - 5The first instance created would be named LUMINAIRE100, the second LUMINAIRE105, the third LUMINAIRE110 etc. If the name already exists the Aplication Explorer automatically selects the next available in the series.Adding a categoryCategories are a convenient way to organize your templates. For example you could create a category called BMS in which you placed all templates relating to building management systems. Categories do not have any impact on the structure of the application that will be generated, nor do they appear in an applications folder structure in the Windows file explorer (unlike a library).1. In the right pane of the Application Architect select the Templates tab.2. Using the templates configuration tree select the library and/or category under which the new category will be saved. 3. Select Add a category. A new category with a default name is created.4. Edit the name to one appropriate to you application. You can either edit the name directly by clicking on it in the configuration trees or edit it in the Name field in the properties grid.5. Add a description using the Description field in the properties grid. The description is optional.How to Add Variables to a Template1. In the right pane of the Application Architect select the Templates tab.2. Using the templates configuration tree select the template to which the variable will be added.3. Using the secondary navigation tree select the Configurationelements folder.4. Select Add a variable followed by the type of variable to create. A new variable with a default name is created.5. Edit the name to one appropriate to your application. You can only edit the name directly by clicking on it in the configuration tree. Show picture 6. Configure the variables properties (see below).The name of the variable appears in the generated application as part of the generated variables name. If the name does not include a branch separator (full stop) then it becomes the final element (leaf) of the variables name. If the name includes one or more branch separators then it becomes the final branches and leaf of the variables name.Configuring a variables propertiesTo configure a variables properties, select the variable in the secondary navigation tree and its properties appear in the properties grid. Show picture The properties that are available are the same as those if you were configuring variables singly using the traditional configuration tools. See the book about Variables for information.For information on property differentiation see the book Differentiation.Configuring a variables advanced propertiesBy default only the basic properties are displayed. To display the advanced properties, right click in the properties grid and, from the context menu, select the Advanced command.To display a variables extended attributes set the Use extended attributes property to Yes.Some properties are context sensitive. For example the alarm level which only appears if a bit has been configured as an alarm.How to Add Associated Behavior to a VariableThis topic explains, in general terms, how to add associated behavior to a var