Siemens Industrial Spares

Transcription

1 s SIMATIC PCS 7/APACS+ OS DBA Users Guide for V6.1 Manual Preface, Contents Quick Start 1 Project Setup 2 AS View 3 Plant View 4 PC Station View 5 Compiling the Project 6 Object Attributes 7 Advanced Topics 8 Configuring APACS+ for Use with DBA 9 Edition 11/2005 A5E Siemens Industrial Spares

2 Safety Guidelines This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring to property damage only have no safety alert symbol. The notices shown below are graded according to the degree of danger.!!! Danger indicates that death or severe personal injury will result if proper precautions are not taken. Warning indicates that death or severe personal injury may result if proper precautions are not taken. Caution with a safety alert symbol indicates that minor personal injury can result if proper precautions are not taken. Caution without a safety alert symbol indicates that property damage can result if proper precautions are not taken. Qualified Personnel Prescribed Usage Notice indicates that an unintended result or situation can occur if the corresponding notice is not taken into account. If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage. The device/system may only be set up and used in conjunction with this documentation. Commissioning and operation of a device/system may only be performed by qualified personnel. Within the context of the safety notices in this documentation qualified persons are defined as persons who are authorized to commission, ground and label devices, systems and circuits in accordance with established safety practices and standards. Note the following:! Warning This device and its components may only be used for the applications described in the catalog or the technical description, and only in connection with devices or components from other manufacturers which have been approved or recommended by Siemens. Correct, reliable operation of the product requires proper transport, storage, positioning and assembly as well as careful operation and maintenance. Trademarks All names identified by are registered trademarks of the Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner. Disclaimer of Liability We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions. Siemens AG Automation and Drives Postfach NÜRNBERG GERMANY Copyright Siemens AG 2005 A5E Siemens AG 2005 Technical data subject to change.

3 Preface Purpose of the Manual This manual provides information necessary use to migrate an APACS+ HMI to a PCS 7 OS using the Database Automation (DBA) utility V6.1. Required Basic Knowledge Readers are presumed to be expert in the use of APACS+ HMI software. Where is this Manual valid? This manual is valid for the software package PCS 7/APACS+ OS Options V6.1. Training Centers Siemens Technical Training Center provides extensive training for all levels of plant personnel to ensure optimal performance from APACS+ and PCS 7 control systems. Classes include extensive hands-on activities using appropriate equipment, making the training directly and immediately applicable. On-line information is available: Siemens also offers a number of training courses to familiarize you with the SIMATIC S7 automation system. Please contact your regional training center or our central training center in D Nuremberg, Germany for details: Telephone: +49 (911) Internet: Siemens Industrial Spares A5E i

4 Preface A&D Technical Support Worldwide, available 24 hours a day: Nürnberg Johnson City Beijing United States: Johnson City, TN Worldwide: Nürnberg Asia / Australia: Beijing Technical Support and Authorization Local time: Monday to Friday 8:00 AM to 5:00 PM Telephone:+1 (423) or +1 (800) (USA only) Fax:+1 (423) Mail to: techsupport.sea@siemens.com GMT: -5:00 Technical Support 24 hours a day, 365 days a year Phone:+49 (180) Fax:+49 (180) ad.support@siemens.com GMT:+1:00 Authorization Local time: Monday to Friday 8:00 AM to 5:00 PM Phone: +49 (180) Fax: +49 (180) Mail to: ad.support@siemens.com GMT: +1:00 Technical Support and Authorization Local time: Monday to Friday 8:00 AM to 5:00 PM Phone: Fax: Mail to:ad.support.asia@siemens.com GMT:+8:00 Automation and Drives Service and Support International The languages of the SIMATIC Hotlines and the authorization hotline are generally German and English. ii A5E

5 Contents Preface Contents 1 Quick Start Program Operation and Conventions Quick Start Steps Project Setup Creating a New WinCC Project (6.1) Creating or Opening a DBA Project Importing a Legacy V5.2 DBA Project Importing a Legacy V6.0 DBA Project Opening, Saving, and Closing a DBA Utility Project AS View Adding APACS+ AS Nodes to a Project Adding OPC Server AS Nodes to a Project Loading (Updating) Controller Objects Saving Loading (Updating) Details to a Log File Selecting an AS Node Refresh Rate AS View Fields HMI Comment Injection (HMI Overlay File) Plant View Creating the Plant View Adding a Plant View Folder Assigning Controller Objects to the Plant View Auto-Assigning Resources to the Plant View Unassigning (Deleting) Plant View Objects PC Station View Adding a PC Station Adding PC Station Applications to APACS+ Architectures Editing Application Properties Renaming or Deleting an OS from a PC Station Updating OS Cache Compiling the Project Assigning an OS to a Plant View Folder Compiling (Start Compile) Running the OS in Runtime Object Attributes Attribute Details Alarm Attributes Graphic Attributes Decimal Place Attributes Object Attribute Editor Importing and Exporting Object Attributes Advanced Topics 8-1 Siemens Industrial Spares A5E iii i iii

6 Contents 8.1 Advanced Topics Controller Objects Checking for Duplicate and Missing Symbols Ensuring Unique Object Names Importing and Exporting the Plant View Configuring APACS+ for Use with DBA DBA Utility Capabilities mation HMI Comments Configuring 4-mation for Individual OS Variables Configuring 4-mation for Structured OS Variables Defined Type File Layout and Syntax Defined Type Variable Comment Syntax Defined Type Message Comment Syntax Defined Type Extended Attribute Comment Syntax Generating Alarms Outside the Controller Storing Alarm Acknowledgements and Alarm Lock Outside the Controller Function in a Defined Type File Built-In Defined Type File Functions User Defined Functions Variable Source Syntax Variable Attribute Syntax Variable Parameter Syntax Defined Type File Editor iv A5E

7 1 Quick Start 1.1 Program Operation and Conventions Primary GUI Quadrants or Panes The DBA utility opens to a graphical user interface (GUI) window that comprises four distinct panes or quadrants: Plant view: the upper panes of the window depict the plant view. The upper left pane, sometimes called the technological view, provides the hierarchical plant view, where objects are represented as folders that can be expanded to reveal their contents or closed to show uncluttered hierarchical relationships. The upper right pane typically shows details about objects selected in the left pane. Tabs on the right pane switch between general characteristics of the selected objects' attributes, some of which are subject to editing and selection. Physical objects: the lower panes provide hierarchies and details associated with the physical equipment that makes up the automation system (AS), such as controllers and I/O modules, and the PCs that provide the data collection, monitoring, operator interfaces, and data storage. When a controller has been selected in the left pane, for example, the right pane displays the function blocks that make up the controller. Dragging and Dropping Objects: the program typically supports moving objects from one quadrant to another by dragging and dropping. Siemens Industrial Spares A5E

8 Quick Start Menus and Toolbar 1-2 A5E

9 Quick Start Unique Naming The DBA utility requires objects to have unique names. The name of an object is its complete hierarchy name. The DBA utility enforces this requirement by adding a suffix to a name that would otherwise not be unique. If you create a folder, for example, its default name is Folder. If you create another, its default name is Folder1, and so forth: Renaming Objects Objects can be renamed by right-clicking and selecting Rename from a context menu. Colors Blue--a read-only value, object or attribute cannot be edited. Green--an object has changed and will not be updated in the target OS until the change has been compiled. Unsaved Changes in a Project An asterisk follows the project name on the title bar of a project that contains unsaved changes: Cautions The DBA Utility Overwrites Edits Made with SIMATIC Picture Tree Manager Siemens Industrial Spares A5E

10 Quick Start The DBA utility overwrites manual edits made in SIMATIC Picture Tree Manager. Do not use the Picture Tree Manager when using DBA to create the Picture Tree. Instead, edit picture trees with the DBA utility. Invalid Characters in Folder and Picture Names Do not use the following character (vertical bar) in folder or picture names: Blank spaces are not allowed in pictures names. The filename of a picture-picture tree file (.pdl) may begin with an amperstand (&), but if it does, the picture is not available in a PCS 7 OS area's drop-down picture tree list. In addition, folder and picture names must use characters that are valid in Microsoft file names. The DBA utility prevents you from naming folders and pictures with the following invalid characters: \ / : *? " < > 1.2 Quick Start Steps Using the DBA Utility The quick-start procedures follow a general path for migrating an automation system (AS) to a PCS 7 OS HMI. An AS consists of all controllers and PLCs with their associated I/O. The purpose of the Quick Start procedures is to impart a sense of the operations and considerations involved and to serve as an introduction to the Advanced Topics. The quick-start procedures do not address considerations related to preparing the source AS application for migration. These are covered in the sections beginning with the title DBA Utility Capabilities. Steps 1. Creating a New WinCC Project 2. Creating a DBA Project 3. Adding APACS+ AS Nodes to a Project 4. Adding an OS to a Project (PC station definition) 5. Adding PC Station Applications to APACS+ Architectures 6. Creating the Plant View 7. Assigning an OS to a Plant View Folder 8. Compiling (Start Propagation) 9. Running the OS in Runtime 1-4 A5E

11 2 Project Setup 2.1 Creating a New WinCC Project (6.1) Each operator's station (OS) exists as a separate PCS 7 OS project, so you must create a project for each OS to which you wish to map automation system (AS) tags. Instructions for creating a WinCC Project using Simatic Manager are found in the publication APACS+ OS Setup Guide for V6.1 (A5E ). This documentation is included with V6.1 software. 2.2 Creating or Opening a DBA Project To create a new project: 1. Select Start > Simatic > DBA > PCS 7 DBA The DBA Utility starts. 2. Select File > New Project A blank project opens in four distinct windows. The caption bar indicates that the project is new: 2.3 Importing a Legacy V5.2 DBA Project You can import a DBA project created in a 5.2 version of the utility into the current version. Doing so allows you to take advantage of new features without repeating the engineering effort required for the original migration. The session is stored in a file whose default name is 4-mationSession.xml. This file is created automatically. You may have to search for it to locate it. Importing recreates ASs, PC stations, the plant view, and associated pictures. Siemens recommends that importing be performed on a fresh, newly created project because importing a legacy project into a project already populated with objects can have unpredictable results. 1. Right click the Plant View or PC Station View icon. A context menu appears (the PC Station View appears below; the Plant View context menu is similar): 2. Select Import Legacy APACS+ DBA Session File. A Select APACS+ Legacy Session File window opens. Siemens Industrial Spares A5E

12 Project Setup 3. Select the.xml file associated with the legacy project. The default name is 4-mationSession.xml. Click the Open button. A Command Status window opens and shows the progress of the import. 4. Ensure that the hierarchy settings in the project match the settings used in the original DBA 4-mation session (in the topic Ensuring Unique Object Names see Hierarchy Settings for details). Failure to match the original hierarchy results in the creation of duplicate symbols in existing graphics. 5. For each root folder in the plant view, right click and select the Edit Folder Properties feature to associate the folder with a PCS 7 OS server application 6. Associate the folder with the same OS Server application as in the legacy application. Do this by checking the appropriate OS under Assigned Components and clicking the OK button: 7. Repeat steps 5 and 6 for each root level folder in the plant view. 2-2 A5E

13 Project Setup 8. Set the OS Area level setting in the Hierarchy Settings to level 2, as shown below: Replacing the Current Symbol Set with New, Smaller Symbols In addition to the standard symbol set, a new, smaller symbol set is also provided. If you would like to incorporate this new, smaller symbol set in your application, follow the steps below 1. Delete the old symbols from the.pdl graphic files. They must be removed from the.pdl graphic file before new ones can take their places. 2. In the DBA utility, edit the Symbol Name (SN) attributes of the objects for which you wish to use new symbols. See the topic Graphics Attibutes. Notice If you do not first delete the existing symbols from the graphics, the new symbols will not be placed. 3. If you have created custom graphics in your old project, add folders to the picture tree having the same names as these graphics. If you do, when you compile the project, the DBA utility automatically associates these.pdl files with the folder names in the PCS 7 OS picture tree. 2.4 Importing a Legacy V6.0 DBA Project The preparation required for importing a legacy V6.0 DBA project varies according to the degree of customization performed on the legacy project. If the project to be updated to V6.1 was developed using the APACS+ Basic Application Library and the default defined type files, block icons and faceplates, the steps to update a server or single-station project are simple: 1. Open the DBA utility program. 2. Perform an entire OS compile. If the project consists of customized defined type files, block icons, and faceplates, these components must be updated before opening DBA and performing a compile. Defined Type Files All defined type files have be updated in V6.1 to provide support for the following: Alarm subsystem that allows alarms to be generated in the HMI Siemens Industrial Spares A5E

14 Project Setup Storage of alarm acknowledgments for controller-generated alarms in the controller or in the HMI Synchronization of alarm acknowledgments between redundant servers Persistence of alarm acknowledgments on a server or single-station RESTART Alarm lock Synchronization of tags between redundant servers Persistence of tags on a server or single-station restart Block Icons All block icons have be updated in V6.1 to provide support for the following: Name field back-lighting when there is navigation to a picture using loop-inalarm Alarm group display replacement to support alarm lock A new attribute to define where a faceplate opens Faceplates All faceplates for V6.1 have been updated to provide support for the following: Alarm group replacement to support alarm lock Alarm lock icon Buttons to increase or decrease controller output and setpoint Selection of one- or two-step faceplate operation (two-step operation provides a confirmation dialog box) Pinable icons to keep faceplates open when a new picture is opened 2.5 Opening, Saving, and Closing a DBA Utility Project Opening The utility opens by default to the most recently closed project. No project is displayed when the utility is first run. To open another existing project from the DBA utility program: Select File > Open Project An Open dialog box appears. Browse as necessary and select the project of interest (DBA Utility projects have the file extension.dba) To open a recently opened project from the DBA utility program: Select File, then select the description of a recently opened file, as shown below: To open an existing project from Windows Explorer 2-4 A5E

15 Project Setup Open the folder containing the project of interest (DBA Utility projects have the file extension.dba). Select and double-click the project name or right-click and select Open. Saving A project can be saved while underway by any of the following actions: Select File > Save Project or Press the Ctrl + S keys or Click the save button from the toolbar: A project must be saved before the first compile to an OS. The Save Project As window appears if you attempt to compile a project that has not been saved. Saving Project as This function saves the current project under a different name at a specified location. Select File > Save Project As and select an appropriate location. Note that the utility supplies the filename extension.dba. Siemens recommends saving projects in the SIMATIC Manager Project folder to simplify backups. Closing Select File > Close to close a project. If any changes were made since the project was last opened, the utility gives you an opportunity to save your work before it closes. Exiting Select File > Exit to leave the utility completely. If you try to exit from a project with unsaved changes, the utility cautions you and gives you an opportunity to save your changes before exiting. Siemens Industrial Spares A5E

16

17 3 AS View 3.1 Adding APACS+ AS Nodes to a Project For customers familiar with APACS+ systems, an automation system (AS) node is an APACS+ controller configuration stored in an.mbr file. 1. Create and open a new DBA project. See Creating or Opening a DBA Project and Opening, Saving, and Closing a DBA Utility Project. 2. From the menu bar of the DBA utility program, select Edit > Add AS Source Node... (or right-click in the AS View pane). (If multiple AS options are installed, the Select an AS Type window opens. In this case select the line containing the words APACS+ and APACS+ Controller.) The APACS+ Configuration Controller dialog box opens (its fields are initially empty) 3. Click the Generate I/O Tags checkbox to generate I/O tags automatically from the I/O modules in the configuration without inserting HMI comments for each of them. 4. Click the Generate Global Tags checkbox to generate global tags automatically from the global variables except for those variables that are ARRAY type or already exposed by other HMI comments. 5. Click the Write Alarm Acknowledgements and Alarm Lock Status to the Controller check box to write alarm acknowledgements and alarm lock status to the controller. Leaving this box unchecked is useful if controller security has been turned on, or if you want to prohibit writes to the controller for any other reason. 6. Select the System Path Browse button (or enter the resource names and system paths and press the OK button). The system path is typically x:\program Files\ProcessSuite\4-mation. Siemens Industrial Spares A5E

18 AS View For information about the HMI Overlay File see HMI Comment Injection (HMI Overlay File). 7. The APACS+ Browser window opens, showing all possible offline databases stored in the folder. The illustration below shows a typical APACS+ resource selected through the browser: 8. Select the AS node of interest and click the OK button. The APACS+ Controller Configuration window returns with the selected AS resource name and system path fields filled in: 3-2 A5E

19 AS View 9. Click the OK button. The resource appears in the AS List: The default project name is New. An asterisk following the name indicates that the project contains changes that have not been saved: 3.2 Adding OPC Server AS Nodes to a Project The DBA OPC extension supports using a comma-separated variable (CSV) file to define tags and messages from any OPC Server. For convenience, this extension is called the CSV processor. The CSV processor creates a suggested WinCC tag structure based on a set of hints you provide it about the source tag structure of your application. 1. From the menu bar of the DBA utility program, select Edit > Add AS Source Node... (or right-click the AS View pane). If multiple AS options are installed, the Select an AS Type window opens. In this case select the OPC Server type): The PCS 7 OPC Server AS Properties dialog box opens (its fields are initially empty): Siemens Industrial Spares A5E

20 AS View 2. On the General tab, click the Generate... (browse) button to select the CSV file that contains the OPC Server configuration. An AS Node Name field is automatically filled in, but can be edited as necessary. 3. Click the Connection tab to configure the connection to the OPC Server as follows: The Connection Name defaults to OPC, but can be edited. The OPC Server Machine defaults to <LOCAL> and should not be changed. The OPC Server Name must be the PROG_ID of the OPC Server you wish to connect to. You may select it from the pulldown list or type it in manually. Consult your OPC Server s user documentation for details about its PROG_ID. 4. Click the Advanced tab is to configure WinCC tags and suggested WinCC tag structures. These settings provide the hints about the underlying WinCC tag structures: The Delimiter field, a string value, specifies the delimiter used to group similarly named tags into objects. This only affects tags that are not already grouped by the OBJECTINSTANCE column (described in TAGS Header Format Recognized by the CSV Processor, below). 3-4 A5E

21 AS View For example: The CSV file may include the following tags that are not yet grouped by the OBJECTINSTANCE column: PIC100_PV PIC100_SP PIC100_V If the delimiter is set to _, the tags will be grouped into a tag structure called PIC100 with individual elements named PV, SP, and V. Values in the Min Tags Per Struct and Max Tags Per Struct fields provide further hints. Tag structures with less than Min Tags Per Struct or more than Max Tags Per Struct will not be created. You can provide the Exclusions field string values of instance names to exclude from processing (see the screen capture above for an example). These are provided in a comma-separated list. CSV file Syntax The CSV header lines have the following requirements: The first character of the header line must be a colon (:) followed by the column name (for example, :ADDRESS) Column order does not matter Column header case does not matter Rows that start with a semicolon (;) are considered comments and ignored Commas can be defined if the column is enclosed in double quotes If double quotes are needed within a column that is double quoted, use two double quotes to represent one. For Example, the first column has a value of "B3:0/1","",11 """B3:0/1"","""",11",AL_1201A-AL,BIT The CSV processor recognizes two types of header formats, one for tags, the other for messages TAGS Header Format Recognized by the CSV Processor Element ADDRESS NAME TYPE DESCRIPTION OBJECTINSTANCE Description Required column that specifies the address of the tag. This must be complete. Required column that specifies the name of the tag. Required column that specifies the type of WinCC Tag to create (for example,. BIT, DWORD, TEXT8, etc.) Optional column that specifies a description of the tag. This is unused by default, but can be referenced by the DBATypeSystem for #comment tags. Optional column that is used to group multiple tags into an instance of an object of the specified name. Note no checking is done to make sure all instances of objects have the same number of tags or the same tags with the same name and type. OBJECTTYPE Optional column that is used to specify the type name of the object. All objects should specify the same value, but the consistency is not checked. If no type is specified, then no WinCC tag structure will be created. Siemens Industrial Spares A5E

22 AS View PATH EXTERNAL HL LL INITVALUE PERSIST SYNC Optional column that is used to define hierarchy to the Tags and Objects which can be used by the picture tree wizard. Optional column that specifies if the tag is Internal or External. If "0", then Internal, otherwise External. Optional column that specifies the HI LIMIT of the tag. Optional column that specifies the LO LIMIT of the tag. Optional column that specifies the START VALUE of the tag. Optional column that specifies if the tag should be persisted. Default is false. Optional column that specifies if the tag should be synchronized to the redundant partner. Default is false. MESSAGES Header Format Recognized by the CSV Processor Element MSGNAME REFERENCE Description Required column that specifies the name of the message. This is required by the DBA but not used by WinCC. Required column that specifies how the MSG should be attached to an object. The following list defines the options: empty: Attach to all tags with the NAME that matches the CMT attribute. OBJECTTYPE name: Attach to all tags with the NAME that matches the CMT attribute that is part of the objects of the specified TYPE. OBJECTINSTANCE name - Attach to all tags with the NAME that matches the CMT attribute that is part of the objects of the specified INSTANCE name. other: Attach to all tags with the NAME that matches the reference string. ENABLED CLASS TYPE PRIORITY TEXT SUBSTITUTE CTRTRIGGERTAG CTRTRIGGERBIT TRIGGERTAG TRIGGERBIT ACKTAG Optional column that specifies if the message is enabled or not. Default is TRUE. Required column that specifies the class of the message. Required column that specifies the type of the message. Optional column that specifies the priority of the message. Required column that specifies the text of the message. Optional column that specifies the substitution string. Required column that specifies the tag in the controller that triggers the message. This must refer to an absolute tag name. This value will be monitored by the EventStateCalc engine and when the condition is present, will set the condition in the TRIGGERTAG. Optional column that specifies the bit of the CTRTRIGGERTAG that triggers the message. Default is 0. This value can also contain complex comparison logic to be described by the EventStateCalc engine design document. Optional column that specifies the tag that will trigger the message. Optional column that specifies the bit of the TRIGGERTAG that triggers the message. Default is 0. Optional column that specifies the tag that will maintain the ACK state of the message. 3-6 A5E

23 AS View ACKBIT DISABLETAG DISABLEBIT P1 to P10 F1 to F5 Optional column that specifies the bit of the ACKTAG for this particular message. Optional column that specifies the tag that will maintain the DISABLED state of the message Optional column that specifies the bit of the DISABLETAG for this particular message. Optional columns that specify the P1 - P10 attributes of the message. Optional columns that specify the F1 - F5 attributes of the message. Notice BOOLEAN TRUE columns can be specified as -1, 1, true, or t. FALSE columns can be specified as 0, false, or f. Example of a CSV File Consistent with the CSV Processor Notice The line numbers in the sample file provided below are included only for reference (and to show where CRLFs actually occur), These line numbers do not appear in the actual file. In the table below, to facilitate viewing, line breaks have been inserted in the Line Content column. As a result, It would not be possible to extract the Line Content lines with a simple copy-and-paste operation and process them with the CSV Processor without first removing these line breaks. Line number Line Content 01 :ADDRESS,NAME,TYPE,EXTERNAL,DESCRIPTION,PATH,OBJECTINSTANCE,OBJE CTTYPE, HL,LL,INITVALUE,,,,,,,,,,, 02,EventState,SDWORD,0,,Area1,AL_1201A,SingleBitTag,,,0,,,,,,,,,,, 03 """B3:0/1"","""",11",AL_1201A-AL,BIT,1,Receiving Elevator Leg Bearing Temp / Belt Alignme,Area1,AL_1201A,SingleBitTag,1,0,0,,,,,,,,,,, 04 """B3:0/2"","""",11",AL_1201A-S,BIT,1,Receiving Elevator Leg Bearing Temp / Belt Alignme,Area1,AL_1201A,SingleBitTag,,,,,,,,,,,,,, 05 """B3:0/3"","""",11",AL_1201B-AL,BIT,1,Receiving Elevator Leg Underspeed Warning Alarm,Area2/Mike,AL_1201B,SingleBitTag,1,0,1,,,,,,,,,,, 06 """B3:0/4"","""",11",AL_1201B-S,BIT,1,Receiving Elevator Leg Underspeed Warning Status,Area2/Mike,AL_1201B,SingleBitTag,,,,,,,,,,,,,, 07 """B3:0/5"","""",11",AL_1201C-AL,BIT,1,Receiving Elevator Leg Underspeed Shutdown Alarm,,AL_1201C,,1,0,1,,,,,,,,,,, 08 """B3:0/0"","""",11",AL_1201C-S,BIT,1,Receiving Elevator Leg Underspeed Shutdown Status,,AL_1201C,,,,,,,,,,,,,,, 09 """B3:0/6"","""",11",AL_1206A_AL,BIT,1,Grinding Supply Elevator Leg Bearing Temp / Belt A,,,,,,,,,,,,,,,,, Siemens Industrial Spares A5E

24 AS View 10 """B3:0/7"","""",11",AL_1206A_S,BIT,1,Grinding Supply Elevator Leg Bearing Temp / Belt A,,,,,,,,,,,,,,,,, 3.3 Loading (Updating) Controller Objects Loading and Updating refer to translating controller tags and other data structures from AS nodes into the DBA environment. The first translation is loading; subsequent iterations are updating. If the controller's objects change in any way (this includes the addition or deletion of controller objects), use the procedure in the topic to update the DBA Project. After controller objects have been loaded or updated, they appear individually in a list in the Controller Objects quadrant of the DBA Utility program's main window. If the project contains more than one controller, the list displayed corresponds to the selected controller. The process is iterative, and the procedure for initial loading and subsequent updating is the same. The procedure requires that The project has been created. The AS node has been added. 1. Select and right-click an AS Node. A pop-up menu appears. 2. Select Update Controller Objects, as shown in the following illustration (selecting Update All Controller Objects updates all controller objects, including AS nodes not marked as changed): The DBA utility responds by displaying a Command Status window, which includes two progress bars, one labeled Command, the other labeled Step. When the procedure finishes, the Command portion indicates this with the notation Done. The illustration below is typical, but can vary according to type of AS node: The Command Status Step section shows a progress bar at 100% when the procedure finishes. 3. To see a log of the loading or updating process, click the Show Details button. 3-8 A5E

25 AS View The Show Details feature is especially useful to confirm that a small change to a controller node is reflected in the project. The button also leads to a function that archives the displayed details as a text file. An alternative to step 2, above, is to select from the menu bar Run > Update Controller Objects. Doing so updates all AS nodes marked as changed, not just the selected nodes. See the advanced topic, Controller Objects. 3.4 Saving Loading (Updating) Details to a Log File 1. Select the Show Details button during the load or update while the Command Status window is still open. The Command Status window extends: 2. Select the Save button. A Save AS window opens for entering a filename (the default filename extension.log is provided). Notice If Close When Complete is enabled, the Command Status window automatically closes, unless the Show Details box is checked or there are errors or warnings. 3.5 Selecting an AS Node Refresh Rate Changes made to the AS source database are automatically reflected in the AS view within the refresh period. The default refresh period is 30 seconds. Change it by selecting from the menu bar Tools >Option. A program options window appears, which includes a field for setting or changing the refresh rate: Siemens Industrial Spares A5E

26 AS View The default rate is 30 seconds. This should be changed if a different scanning frequency is desired. 3.6 AS View Fields Name: The name of the object in the OS. This is the name configured in HMI comments in 4-mation. Type: The type of the object in the AS. This is the type configured in the HMI comment in 4-mation. AS Address: The address of the object in the AS. This is the path to an object on a sheet in 4-mation. Status: This indicates the status of the object. Add: object added to the AS since the last time controller objects were updated. See Loading (Updating) Controller Objects Modified: object changed since the last time controller objects were updated. Deleted: object deleted since the last time controller objects were updated. blank: object unchanged since the last time controller objects were updated. Assignment: plant view folder to which the object is currently assigned. If blank, not assigned. Description: a description of the object. Notice If you change the name or type of an object, the original object appears in the list as deleted. The new object's name and type appear with the status of Add. 3.7 HMI Comment Injection (HMI Overlay File) The HMI Comment Injection feature supports customers who do not currently use HMI comments in their controller configurations. The entry point to this feature is the APACS+ Controller Configuration dialog box, which includes an edit box labeled HMI Overlay File for specifying an overlay file. You can type a path and filename directly into the edit box or use the Browse... button to find and select it: 3-10 A5E

27 AS View By default the edit box is empty and no injection occurs. If the edit box points to a properly formatted comma-separated variable (CSV) file, then the information from that file is inserted into the 4-mation export file before it gets processed by DBA. As a result, HMI comments of any type can be inserted into any part of the controller configuration without modification to the existing controller configuration. Format of an HMI Overlay CSVFile The first line must have the following two-column format: Tagname,HMIComment The file supports lines with or without double-quote delimiters. Lines beginning with a semicolon (;) are regarded as comments and ignored. The injection processor supports the EXCLUDEMBRCOMMENTS comment command, which for the DBA utility, in effect removes existing HMI comments from the MBR. This comment can be added to any line in the CSV injection file. Tagname in an HMI Overlay File Tagname is generally the string that defines where to inject the HMI comment. It can be any of the following: (see Example HMI Comment Injection File below): Name of the Derived Network, assuming the name of the network is unique. If multiple networks with the same name are found, then a warning is reported. Name of the Standard Function Block (SFB) instance, assuming the name of the SFB instance is unique. If multiple SFB instances with the same name are found, then a warning is reported. Complete address (not including the Resource Name) of the Derived Network (use the Resource Name to address the Resource Sheet) Complete address (not including the Resource Name) of the Standard Function Block Siemens Industrial Spares A5E

28 AS View HMIComment in an HMI Overlay File HMIComment is generally the string that defines the HMI comment to be injected at the location specified by the Tagname. It can be any of the following: (see Example HMI Comment Injection File below): Type Only string. When this is used, the HMI syntax will be created as follows, where HMIComment is replaced with the text from the HMIComment column and InstanceName is replaced with the name of the SFB Instance: Derived Network Reference --> HMI:.:TYPE=HMIComment:REV=4.00 SFB Instance Reference --> HMI:.InstanceName.:TYPE=HMIComment:REV=4.00 Complete the HMI Comment as defined by the standard HMI Comment specification. Example HMI Comment Injection File Tagname HMIComment PIC_100 SINGLE_LOOP VA_100 VALVE_A PLANT_A HMI: GLOBAL1 :TYPE=REAL AA_100 HMI:START:TYPE=BOOL How DBA Interprets the Example HMI Injection File Line beginning with PIC_100: The line PIC_100 causes DBA to search the exported controller configuration for the DFB/UDFB that matches PIC_100. If found, DBA injects an HMI comment onto the sheet in the format HMI:.:TYPE=SINGLE_LOOP. From the perspective of the DBA utility, this line is the equivalent of an HMI comment in the controller. The appropriate tags as defined in the Defined Type file called SINGLE_LOOP are created when DBA compiles to the OS. VA_100: The line VA_100 causes DBA to search the exported controller configuration for the DFB/UDFB that matches VA_100. If DBA does not find a match, it searches for a SFB with this name. Once found, DBA injects an HMI comment in the format HMI:.VA_100.:TYPE=VALVE_A.onto the sheet that contains the SFB. From the perspective of the DBA utility, this line is the equivalent of an HMI comment in the controller. The appropriate tags as defined in the Defined Type file called VALVE_A are created when DBA compiles to the OS. If Tagname is not present, DBA logs a warning to identify the tagname that could not be found. DBA also posts warnings/errors if the HMIComment TYPE= Defined Type File either does not exist or has errors. These warnings and errors include the associated tagname. If an HMI comment is currently in the Controller Configuration, DBA posts a warning, identifying the tagname for which a duplicate HMI comment exists. DBA then uses the comment found in the controller configuration. PLANT_A: The line PLANT_A (PLANT_A is the name of the Resource/ACM) causes DBA to add the HMI comment HMI: GLOBAL1 :TYPE=REAL to the 3-12 A5E

29 AS View Resource Sheet. DBA creates a tag in the OS for this global variable. The Resource Sheet in this example is called PLANT_A. AA_100: The line AA_100 causes DBA to add the HMI comment HMI:START:TYPE=BOOL to the sheet PLANT_A.AA_100 where PLANT_A is the Resource Name and AA_100 is the Program Block instance name. The tag START of type BOOL is created when DBA compiles to the OS. Siemens Industrial Spares A5E

30

31 4 Plant View 4.1 Creating the Plant View Picture trees in PCS 7 OS are created automatically based on the plant view created in the DBA Utility. Defining a plant view with the DBA Utility is an interactive process, and the order of steps required varies depending upon whether you are creating a new plant view or modifying an existing one. Consider using the automated tools to create a template, a proposed hierarchy. You can rename and move picture-tree elements created with these tools to expedite the process. See Auto-Assigning Resources to the Plant View. You can also use right-click functions to delete plant-view elements and start over without significant additional effort. Considerations: Any folder in a plant view can be assigned an OS. After a folder is assigned to an OS, all subordinate folders are assigned to the same OS. The structure created in the plant view is reflected in the creation of.pdl graphics and the navigation scheme of active OS projects. Tags are automatically translated to the PCS 7 OS environment if they are unique. If they are not unique, the tags cannot be created. The DBA utility displays a validation error upon compilation. See Ensuring Unique Object Names. There are two ways to generate a plant view hierarchy, an automated method and a manual method, which can be used together. An automated way to populate the plant view is to permit the DBA utility to create one or more working templates in the plant view. See Auto-Assigning Resources to the Plant View. An OS can be assigned to a working template or you can drag and drop elements from the working template to objects within the plant view. You are also free to rename and delete folders and objects. Drag-and-drop functions make it easy to select among objects in the working template, for example, and incorporate them into a folder that can be assigned to an OS. A manual way to create subordinate structures (folders) in a folder is to select it and use the right-click, create-folder functions to create a hierarchical picture tree (at a maximum of 5 folders deep). The default name is Folder1. You can rename these folders with a maximum of 24 characters (unless the permissible size of folders is fewer than 24 characters. See Ensuring Unique Object Names ). The system ensures that folders have unique names by incrementing the number following the base folder name. You can return to this step any time before compiling the database to create or modify the structures. Siemens Industrial Spares A5E

32 Plant View Notice Every folder must have an OS assigned somewhere in its ancestry. See Assigning an OS to a Plant View Folder. Creating a Plant View 1. In the Plant View quadrant, right-click the root-node icon labeled New. A context menu appears: 2. Click Add Folder. An icon representing a folder appears (Folder is the default name of the first folder created in this way; Foldern is the default name for subsequent folders. You can select a folder and right-click to change its name (subject to some restrictions; see Ensuring Unique Object Names). Repeat for each folder you wish to create. In the following illustration, three folders have been created: You can combine the automated and manual methods, renaming as necessary. The illustrations below show, on the left, a plant view with three unpopulated folders: Folder, Folder1, and Folder2. Below the folders are three templates created with the auto-assign function: Templates, Templates1, and Templates2. The illustration on the right shows the result of dragging the contents of the templates into the folders, leaving the templates empty. 4-2 A5E

33 Plant View The illustration below shows the same plant view after the empty templates have been deleted. A folder can be assigned to an actual OS by right clicking on the folder and selecting Edit Folder Properties. See Assigning an OS to a Plant View Folder for more information. The DBA utility program creates a picture for each folder. This picture cannot be deleted, but it can be renamed. By default the picture name will be the same as the folder name. In the above illustration, for example, Folder is used for both the folder and the picture. If you have existing pictures (.pdl files) from another source you can assign them to the picture tree by renaming the picture tree name in the picture tree to the name of an existing.pdl file. For example, you can rename the Folder picture by selecting it, right-clicking, and renaming. Siemens Industrial Spares A5E

34 Plant View If the Create/Update Block Icons options is set in the Compile dialog box, the DBA utility will create a new picture if the picture does not exist. 4.2 Adding a Plant View Folder Please be familiar with the automated capabilities of the utility, described in Auto-Assigning Resources to the Plant View, before performing the following manual procedure. The plant view is organized into folders. During compilation, a.pdl graphics file is created for every folder in the plant view. Every controller object that is assigned to a folder is automatically added to the.pdl file which corresponds to that folder, greatly simplifying the process of creating process graphics. The organization of folders in the picture tree defines the navigation scheme for an OS. 1. Select a folder in the plant view. 2. Select Edit > Add Folder (or right-click a folder and select Add Folder) A new folder appears in the plant view. A folder's default name Folder is editable immediately after it has been added. To change the name later, select the folder, right-click, and select Rename. If the entered name is not unique, the change is rejected and the old name is restored. You can add folders five deep: 4.3 Assigning Controller Objects to the Plant View Please be familiar with the information in Auto-Assigning Resources to the Plant View before completing the following procedure. 1. Create a DBA project. See Related topics Assigning an OS to a Plant View Folder Adding APACS+ AS Batch Nodes to a Project Creating or Opening a DBA Project 2. From the AS view, select the AS of interest, right-click, and select Update Controller Objects. See Loading (Updating) Controller Objects 3. Select a controller object in the AS Objects pane. 4-4 A5E

35 Plant View 4. Drag and drop the controller object onto a folder in the plant view. The cursor becomes a "not" icon, as shown in the following illustration, if it hovers over a picture tree object that is not a folder. The drop operation is permitted only on a folder. When the cursor hovers above a folder, the cursor becomes a plus (+) sign, indicating that the drop operation is permitted: It is possible to drag and drop multiple controller objects in a single operation. Windows list-selection techniques apply in the list of controller objects (shift-click to select contiguous objects, control-click to add objects). In addition, if the cursor is in the list of controller objects, the conventional select-all key code (Ctrl+ A pressed simultaneously) selects the entire list. You can also assign all controller objects to a folder by drag-and-dropping an AS node. This displays a percent-complete dialog box and an option to halt the operation. Finally, in addition to dragging items to the plant view directly, it is possible to select a folder in the plant view and drag an item to the Objects tab to the right of the Plant View as shown below. This has the same effect as dragging the object or objects directly to the plant view folder. Lifebeat Monitor Notice For the PCS 7 Lifebeat Monitoring System to operate correctly, the RESOURCE_STATUS_AFB block for each controller must be mapped to the PCS 7 OS. 4.4 Auto-Assigning Resources to the Plant View The DBA Utility can examine the structure of your AS database and create a proposed plant view hierarchy based upon the names of controller objects and their apparent relationships to one another. Siemens Industrial Spares A5E

36 Plant View Plant view elements created in this way can be renamed as necessary and moved among hierarchies created automatically or manually. In the plant view, a "working template" is created which contains a provisional plant view and a set of object assignments. After the auto-assignment is complete, you can make whatever manual changes you require, including moving folders from the working template to other folders in the plant view. When you use the auto-assign feature, the hierarchy created in the working template is based on the hierarchy specified for the resource in 4-mation. 1. In the AS view, select an AS from the AS list. 2. Right-click and from the shortcut menu select Auto-Assign Resources to the Plant View: The DBA utility offers an opportunity to ensure uniqueness in object names. See Ensuring Unique Object Names. Auto-assignment is useful if the working template is to be a starting point for the plant view configuration, but does not match exactly the desired final form of the plant view. Alternatively, the entire working template can be dragged to another folder in the plant view to create an entire plant view in one drag-and-drop operation. The illustration below on the left shows a plant view with four folders. The autoassign utility created Templates and Templates1. The folders Area1 and Area2 were created with the right-click, add-folder function. The illustration on the right shows the plant view after the content of the templates folders were draggedand-dropped onto the AreaN folders and the template folders were deleted: 4-6 A5E

37 Plant View 4.5 Unassigning (Deleting) Plant View Objects There are several ways to remove objects from the plant view. (Removing a controller object from the plant view does not remove it from the list of controller objects in the AS view, only from the plant view.) Right-click the object and select Unassign: Select the object and press the keyboard Delete key (one object at a time). Select the object and press the keyboard Delete key (when done from plant view detail list view, this technique allows multi-deletion). Drag a symbol from the plant view and drop it on an AS list view (one object at a time). Notice The folder name and the picture name as displayed in DBA should be kept the same to avoid confusion for those maintaining the system. Siemens Industrial Spares A5E

38

39 5 PC Station View 5.1 Adding a PC Station Adding a PC Station 1. Start the DBA Utility and open an existing DBA project or create and open a new project. See Creating or Opening a DBA Project and Opening, Saving, and Closing a DBA Utility Project. 2. Select the PC Station View tab in the bottom pane. A node named New appears in the window: 3. Right Click the New node and select Add PC Station: The bottom right pane provides a Value column for entering the PC station name, Node_052 in the example below: 4. If your system architecture includes more than one PC station, you can add and name them now or return to this step later. After a PC station is added, you can add an application to it (see Adding PC Station Applications to APACS+ Architectures.) 5.2 Adding PC Station Applications to APACS+ Architectures Within the context of the DBA utility program, to add an application to a PC station is to specify or determine its function within a system architecture. Siemens Industrial Spares A5E

40 PC Station View The illustration below shows a typical multiple station architecture. Node_165 is an optional engineering station (ES), which is included in most architectures. Most organizations prefer to keep engineering functions on a PC that is not used for control. For purposes of illustration, the DBA utility is running on this engineering workstation. Single-Station Architecture 1. Using the procedure in Adding a PC Station, add a PC station for the APACS+ single station. In the illustration below, this PC station has been added and its name has been changed to Node_177. The attribute field Computer Name has been edited to correspond to this network name: 2. Right-click the PC station and select Add Application from the context menu: The Select an Application Type window appears: 5-2 A5E

41 PC Station View 3. Select PCS 7 OS (Server/Single Station) and click the OK button. A properties window opens: 4. In the Offline MCP File value field, use the browse button to find the name of the current PCS 7 OS project. (This project resides on the system performing engineering functions. In the architectural drawing above, this is Node_165.) An open-file dialog box appears so you can find and select the.mcp file associated with the project: After you click the OPEN button, the Offline MCP File value field contains the filename and path of the.mcp file: Siemens Industrial Spares A5E

42 PC Station View Notice Multiple OS nodes can not be assigned to the same.mcp file. It is not necessary to specify an Online MCP file. The Standby OS field contains <none> because the system architecture does not include a redundant OS server. An alternate method of editing PC Station properties is available. See Editing Application Properties. Multiple Station Architecture The illustration below show an APACS+ architecture with a redundant server. Node_165 is an optional engineering station (ES) that is included in most architectures. 1. Using the procedure in Adding a PC Station, add PC stations for each PC in the system architecture. For purposes of illustration the server is Node_179 in the above system architecture. Ensure that the Computer Name fields correspond to the network names of the PCs: 5-4 A5E

43 PC Station View 2. The result is a PC station view similar to the following: 3. Right-click the PC station that is destined to be the OS server and select Add Application from the context menu: The Select an Application Type window appears: 4. Select PCS 7 OS (Server/Single Station) and click the OK button. A properties window opens: Notes: Siemens Industrial Spares A5E

44 PC Station View (1) It is not necessary to configure the Online MCP file. (2) It is not necessary to configure the Standby OS. 5. Repeat the above procedure to configure a redundant (standby) OS if your system includes one. If a standby OS has been defined, the Standby OS attribute for the OS server field will have a drop-down menu with the standby OS available as a selection. Any time after it has been defined, you can return to this server's Standby OS attribute field to specify it. You can also use an alternate method to specify it. See Editing Application Properties: 6. Repeat these steps for every OS sever or OS server pair in your system. Configuring OS client applications is not necessary. An alternate method to specify PC station application properties is available. See Editing Application Properties. 5.3 Editing Application Properties After an application has been assigned to a PC station, it is possible to change any of its attributes through this procedure: 1. Expand the PC station hierarchy containing the application. The assigned application or applications are listed (for example, OS and OSStandby). 2. Right-click the application of interest. A context menu appears. 3. Select Edit Object Properties... from the context menu. A window opens containing fields for the configurable attributes. The following window is for an OS application: 5-6 A5E

45 PC Station View 4. Use the browse button if it is available or enter information directly. Check the OK button to register any changes. Notice Multiple OS nodes can not be assigned to the same.mcp file. 5.4 Renaming or Deleting an OS from a PC Station Please be familiar with the automated capabilities of the utility, described in Auto-Assigning Resources to the Plant View, before performing the following manual procedure: 1. Select the OS in the PC Station View 2. Right-click and select Rename or Delete from the menu: If you press Rename, the OS name becomes selected, editable text. Type the desired name and press the Enter key or move the cursor off the edit box and click. 5.5 Updating OS Cache To simplify the browsing for information stored in the WinCC database, DBA provides a caching feature. This cache stores all of the alarm types and classes that have been configured in the WinCC project (using the OS Project Editor). A cache is maintained for each OS in the DBA project, and it is updated by DBA automatically every time an OS is compiled. It is also possible to update this cache manually. To update the cache manually: 1. Locate the PC station containing the OS of interest. 2. Right-click the OS application. 3. Select the Refresh OS Cache option. Siemens Industrial Spares A5E

46 PC Station View 5-8 A5E

47 6 Compiling the Project 6.1 Assigning an OS to a Plant View Folder Notice The assignment of OS servers to plant view folders is highly dependent on the hierarchy options that you have configured in DBA. The number of plant view folders that need to be assigned to OSs depends on the number of OS Servers that are configured in your system and how you have partitioned them (as reflected in the hierarchy options in DBA). In the section titled Ensuring Unique Object Names see the subtopic Hierarchy Settings for more details. The procedure below describes how to make a single assignment of an OS to a plant view folder. 1. Right-click the plant view folder of interest. 2. Select Edit Folder Properties... from the context menu 3. Use a checkbox to select an OS from the Folder Properties window 6.2 Compiling (Start Compile) Compiling is translating a selected DBA project to a WinCC database. A design goal of the DBA Utility is to make incremental compiling as simple as possible, so that a small change to an AS can be readily accommodated in a WinCC project. Successful compiling requires the following: Siemens Industrial Spares A5E

48 Compiling the Project A WinCC project A specified AS source An OS and at least one folder to which the OS is assigned AS controller objects assigned to the OS Notice changes made to an.hmi file are not compiled unless the changes are registered by the Loading (Updating) Controller Objects function. Related topics Assigning an OS to a Plant View Folder Adding a PC Station Assigning Controller Objects to the Plant View Creating or Opening a DBA Project Procedures Notice If you are compiling a DBA project that includes a single OS Server, be sure that the WinCC runtime is not active. If you are compiling a DBA project that includes multiple OS Servers, be sure that the WinCC Explorer is either closed, or, if running, does not contain an opened WinCC Project. To compile all OSs in the DBA Utility Project, do any of the following: Select Start Compilation Press the F5 key Click the compile button: 6-2 A5E

49 Compiling the Project OS Compile Options Entire OS: Compiles the entire OS project. This is the only option available the first time an OS is compiled. It is also the only option available the first time an OS is compiled after upgrading the DBA utility program. When Entire OS is selected, all tags, alarms, structures and elements created by the DBA utility are deleted and replaced with new objects during the compilation. Changes: This is the default option for a previously compiled project. Only changes made since the last compile are compiled. The following options are ordinarily checked: Tags and Messages: If this box is checked, all tags and messages are created. In most cases this should be checked. Create/Update Block Icons: If this box is checked,.pdl files are updated as part of the compile process. Picture Tree: If this box is checked, the picture tree or trees of the PCS & OS Server are updated. When the selection of options is satisfactory, click the Compile button. An error related to duplicate or missing symbols produces a Command Status... error message. See Checking for Duplicate and Missing Symbols. The result of a compilation is written to a log, which can be stored as a text file on a hard disk drive or other secondary memory. The log is visible by clicking the Show Details checkbox. The Save button saves the timestamp, message, and level information displayed when the Show Details button is clicked. A Save As dialog box opens for saving this information in a.log file. If an OS requires recompiling, the new or changed objects are rendered in green. In the illustration below, Area1 has changed because new objects have been added beneath it. Note that only folders that have added or deleted items will be marked as changed (colored green). Folders that contain an item that was modified will not be marked as changed since only the item changed, not its parent folder. In addition, the top level folder that is assigned to an OS will be marked as changed if any of its subfolders or items are changed. Siemens Industrial Spares A5E

50 Compiling the Project Recompiling this OS results in a message in the log like the one shown in the following fragment from a log file: 4/9/ :54:31 AM 2 Querying Project Database... 4/9/ :54:31 AM 1 Compiling 'OS' PCS 7 OS (Server/Single Station)... 4/9/ :54:31 AM 2 Opening Target... 4/9/ :54:31 AM 3 Compile Scope: Changes 4/9/ :54:31 AM 3 Compile Options: 4/9/ :54:31 AM 3 Tags and Messages - Yes 4/9/ :54:31 AM 3 Picture Tree - Yes 4/9/ :54:31 AM 3 Create/Update Block Icons - Yes... 4/9/ :55:58 AM 1 Compiling...Completed The object highlighted in green returns to normal after the recompiling. 6.3 Running the OS in Runtime 1. Select Start > Simatic > WinCC > Windows Control Center. The explorer opens the most recently opened project. If this is not the project you wish to run, close it and open the project of interest. 2. Click the Activate button in the menu bar: The project HMI opens. 6-4 A5E

51 7 Object Attributes 7.1 Attribute Details After you have finished organizing the graphical structure of the picture tree for controller objects, you can assign, examine, and modify some object attributes. The attributes available for this kind of change vary with the object and with the AS system from which they are derived. When the object is highlighted in the OS View pane, its attributes appear in the Detail pane to the right. Any editable attribute is highlighted when the cursor sits on the row containing the object's attributes. As the illustration below shows, when ANALOG_ALARM is selected in the OS View pane, and the cursor is on the AD6 row in the Detail pane, the Alarm Priority value of 16 can be changed. Object attributes listed in the right pane can be sorted in ascending or descending alphanumeric order (a toggle) by clicking column headers. For example, to sort by value, click the column header cell labeled Value. To switch between ascending and descending order, click the header cell again. See also: Importing and Exporting Object Attributes Object Attribute Editor Alarm Attributes Graphics Attributes Decimal Place Attributes 7.2 Alarm Attributes These attributes determine how alarms are handled in PCS 7 OS. Alarm Priority There is an alarm priority attribute for every alarm that can be generated for an object. Each alarm that can be generated for the object can be assigned a unique priority, from 0 to 16 (where 16 is the highest priority and 0 the lowest). To change the alarm priority, click on an alarm priority object from the Detail pane of the OS view and enter a value from 0 to 16 Siemens Industrial Spares A5E

52 Object Attributes The WinCC Alarm Logging feature determines the Alarm Classes and Alarm Types that are available for an object. See the on-line help file linked to this topic for more information: Start > Simatic > WinCC > Window Control Center 6.0 > Alarm Logging Message Class An alarm class setting determines the message class for every message that can be generated by an object. A pulldown list shows all defined message classes in the WinCC alarm logging function. Message Type A message type setting determines the message type (within a selected message class) for every message that can be generated for an object. A pulldown list shows by number all of the message types defined for the selected class. The DBA utility program reads this type number but cannot read the words or phrases associated with the number. To determine these, you must examine them from the WinCC Explorer: 1. Select Start > Simatic > WinCC > Window Control Center 6.0 > Alarm Logging. A list of message classes appears in the upper right pane of the display (Alarm, Warning, Tolerance, etc): 7-2 A5E

53 Object Attributes 2. Select and right-click the message class of interest (Alarm, Warning, Tolerance, etc). and select Properties from the context menu. The window displayed below shows the message types for the Tolerance class. 3. Select the Message Type of interest (such as Tolerance High) and click the Properties button. A Type window opens and reveals the type number. Returning to the DBA utility, a Type attribute contains a pulldown menu that allows selection by number of a type supported by a message class. In the illustration below, the class is Warning and the available types are Type1, Type2 and Type3. Use the procedure listed above to determine the meaning of these types. Siemens Industrial Spares A5E

54 Object Attributes Note: The alarm and class pull-down menus are only available for controller objects that meet these conditions: The objects have been assigned to a folder. The folder has been assigned to an OS. The OS has been assigned to an OS server. The OS server has been compiled at least once. OR The Updating OS Cache function has been enabled for the OS server. 7.3 Graphic Attributes Every object has associated with it a Symbol File (SF) and Symbol Name (SN) attributes. When DBA creates.pdl files during compilation, it creates a picture corresponding to each Picture Tree folder. For each object in the folder, a symbol is inserted into the folder. The symbol file and symbol name graphics attributes determine which symbols DBA will insert into each.pdl. The content of a.pdl file that begins with a amperstand (&) character is not be available in the OS area drop-down selection box. When objects are inserted by DBA, a suitable default value for symbol file and symbol name are set, based on the type of object. However, if you would like to customize particular instances of objects to appear differently within the.pdl file, you can change the symbol file and/or symbol name attributes associated with alarm attributes. Symbol File (SF) A symbol file represents a file which contains a set of symbols which are used to generate.pdl files automatically from DBA. Using this attribute, it is possible to maintain multiple sets of symbols that are used in different circumstances. For example, one file might contain a set of large symbols. A second file may contain symbols with exactly the same names, but with smaller symbols. Symbol Name (SN) A symbol name represents the name of a symbol within Symbol File which will be inserted by DBA when creating a picture using that object. For example, if the file referenced in Symbol File contains the symbols SingleLoop/1 and SingleLoop/2, you may wish to use Symbol Name of SingleLoop/1 for some objects, and SingleLoop/2 for other objects. 7-4 A5E

55 Object Attributes 7.4 Decimal Place Attributes The number of decimal points displayed on symbols and faceplates is configurable on a tag-by-tag basis in DBA. The following table shows which decimal point tags affect which HMI tags. Block Decimal Places Tag Affected Tags SINGLE_LOOP DecimalPlacesPV.PV,.SP, All Alarm Limits, All Alarm Deadbands, Setpoint Limits, Ramp Target, Ramp Rate.DecimalPlacesOUT.OUT, Output Limits ANALOG_ALARM.DecimalPlacesPV.PV, All Alarm Limits, All Alarm Deadbands DISCRETE_ALARM N/A N/A BLK_VALVE_1OUT N/A N/A BLK_VALVE_2OUT N/A N/A VALVE_A N/A N/A VALVE_A_ALM N/A N/A MOTOR_1OUT N/A N/A MOTOR_2OUT N/A N/A MOTOR_A N/A N/A MOTOR_A_ALM N/A N/A SINGLE_LOOP_SS.DecimalPlacesPV.PV,.SP, All Alarm Limits, All Alarm Deadbands, Setpoint Limits, Ramp Target, Ramp Rate.DecimalPlacesOUT.OUT, Output Limits EXT_SET.DecimalPlacesPV.PV,.SP,.ESP, All Alarm Limits, All Alarm Deadbands, Setpoint Limits, Ramp Target, Ramp Rate.DecimalPlacesOUT.OUT, Output Limits RATIO_SET.DecimalPlacesPV.PV,.SP,.ESP,.RAT_INP, All Alarm Limits, All Alarm Deadbands, Setpoint Limits, Ramp Target, Ramp Rate.DecimalPlacesOUT.OUT, Output Limits.DecimalPlacesRATIO.RAT_ACT,.RAT_DES Siemens Industrial Spares A5E

56 Object Attributes PRIMARY.DecimalPlacesPV.PV,.SP, All Alarm Limits, All Alarm Deadbands, Setpoint Limits, Ramp Target, Ramp Rate.DecimalPlacesOUT.OUT, Output Limits SECONDARY.DecimalPlacesPV.PV,.SP,.ESP, All Alarm Limits, All Alarm Deadbands, Setpoint Limits, Ramp Target, Ramp Rate.DecimalPlacesOUT.OUT, Output Limits CASCADE.DecimalPlacesP_PV.P_PV,.P_SP, All Primary Alarm Limits, All Primary Alarm Deadbands, Primary Setpoint Limits, Primary Ramp Target, Primary Ramp Rate.DecimalPlacesS_PV.S_PV,.S_SP,.ESP, All Secondary Alarm Limits, All Secondary Alarm Deadbands, Secondary Setpoint Limits, Secondary Ramp Target, Secondary Ramp Rate.DecimalPlacesOUT.OUT, Output Limits RESOURCE_STATUS N/A N/A 7.5 Object Attribute Editor The Object Attribute Editor allows bulk editing of object attributes. Its chief use is for editing alarm priorities, but it lends itself to editing other attributes as well. A filtering, or limiting, mechanism makes it possible to isolate the attributes that need editing, such as alarm priority, while hiding others. It is also possible to export object attributes to a.csv file and bulk edit them with an external program, such as Microsoft Excel or Microsoft Word, then import them back into the DBA utility. See Importing and Exporting Object Attributes for more information. Select the folder of interest. Right-click and select Edit Attributes... from the context menu. The DBA Attribute Editor window opens. The title bar indicates whether any attributes are hidden (filtered). Initially, all attributes are visible. You can reduce the information displayed by unchecking the Show... buttons. You can begin editing immediately by clicking the Value cell for the object of interest and replacing the current value with a new value. You may, however, wish to filter and sort the objects first. The Category << and Name>> buttons filter (hide) an object's attributes object to make it easier to focus on the attributes of interest. 7-6 A5E

57 Object Attributes Click the Category<< button to uncheck (hide) attribute types. If you were interested only in alarm priority, for example, uncheck the other types. Click the Category<< button again to register your choice. Any action that reduces the number of objects displayed is recorded in the title bar (see 1, below). Note, too, that you can sort the displayed objects by column value by clicking the column heading. To sort by name for example, click the heading labeled Name (see 2, below). Clicking a column once provides an ascending sort; clicking again toggles to a descending sort. This feature is especially useful if you want to see alarms sorted by priority value. The Name<< button provides additional filtering. To display only the L - Priority, for example, click the Name<< button and uncheck all but the L - Priority box. Then click Name<< again to apply the filter. Siemens Industrial Spares A5E

58 Object Attributes 7.6 Importing and Exporting Object Attributes The controller-object attributes available for import and export vary with the AS. The DBA Utility supports disk-based import and export of controller object attributes. The export feature stores attributes from a selected picture tree object (and all subordinate objects) to a.csv (comma separated variable) file that can be opened and edited with word-processing or spreadsheet tools. The import feature replaces all attributes in a selected object and all of its subordinate objects with any corresponding attributes in the selected file. The imported.csv file can be a file produced by exporting or a file edited or even created independently of the DBA Utility program. Alarms are matched by the path of the object, the alarm type, and the alarm description. Invoke the export or import functions by right-clicking a controller object in the picture tree (limited to root node, OS, and folders). If the object supports attribute import and export, a menu indicates this, as is shown in the following illustration: Clicking Export or Import opens a dialog box for entering a file name. The default directory for exports and imports is the directory used as a source for the controller objects. Format of the.csv file An exported attribute file takes the form shown below. It can be edited with simple text editing tools or with advanced spreadsheet tools that read from and write to.csv files. The first line in the listing is the column headers. Keep in mind that edits made to an imported file can change the object attributes in any object displayed in the picture tree, overwriting the value already there, regardless of the object selected when the import is executed. "ASTagName","ASTagPath","OSTagName","Category","Name","Description","Value" "RMSC_532","""RMSC_532"","""",0","RMSC_532","Alarm Priority","Alarm Disabled","Alarm Disabled","0" "RMSC_532","""RMSC_532"","""",0","RMSC_532","Alarm Priority","Bad Quality","Bad Quality","0" 7-8 A5E

59 Object Attributes "RMSC_532","""RMSC_532"","""",0","RMSC_532","Graphics","SF","Symbol Symbols.pdl" "RMSC_532","""RMSC_532"","""",0","RMSC_532","Graphics","SN","Symbol "RMSC_533","""RMSC_533"","""",0","RMSC_533","Alarm Priority","Alarm Disabled","Alarm Disabled","0" Required columns If a file is created or edited and then used to import object attributes, the required columns are ASTagName: the name of the AS object whose attribute is being defined (for example, SINGLE_LOOP). This name corresponds to the string found in the Name column of the AS View tab's AS Objects List View (on the right). This is a required field for AS object changes, and should be left blank for non-as object changes. ASTagPath: the address of the AS object whose attribute is being defined (for example, LC.LC_PUR.X2320.SINGLE_LOOP). This name corresponds to the string found in the AS Address column of the AS View tab's AS Objects List View (on the right). This is a required field for AS object changes, and should be left blank for non-as object changes. OSTagName: the OS tag that is created by the DBA and is used only to reference objects that are non-as objects such as batch objects (for example, Process$Cell/X2320/SINGLE_LOOP). This is a required field for non-as object changes. Category:This column is the category of the attribute being defined (for example, Graphics) and is related to the Category column of the attribute editor tab (top right). This is a required field. Case must be correct. Name: This column is the name of the attribute being defined (for example, DecimalPlacesPV) and is related to the Name column of the attribute editor tab (top right). This is a required field. Case must be correct. Description: the description of the attribute being defined (for example, PV Decimal Places To Display) and is related to the Description column of the attribute editor tab (top right). This is an optional field, but allows the user to customize the descriptions of attributes which are unchangeable through the DBA interface. Value: the value of the attribute being defined (for example, 2) and is related to the Value column of the attribute editor tab (top right). This is a required field. In summary ASTagName, ASTagPath, and OSTagName columns locate the object to be changed. Category and Name columns locate the specific attribute on the selected object to be changed. Description and Value columns define the new values to be written into the DBA database. Other columns are ignored during imports. Siemens Industrial Spares A5E

60 Object Attributes Log Files If you want to retain a log file recording the results of an import, select the Details button while the import is in progress and the percent-complete window is displayed. Save the results when the import is complete A5E

61 8 Advanced Topics 8.1 Advanced Topics The DBA utility integrates AS configurations and control schemes into the PCS 7 OS. The utility maps tags to a PCS 7 OS environment and creates a hierarchical graphical structure depicting control systems in a PCS 7 OS HMI. The utility offers wide flexibility, and with this comes complexity. While it is possible to devise a step-by-step procedure to provide a quick-start introduction to the utility and its features, no set procedure can accommodate the complexity of customers' applications. The advanced topics provide insight into the features and requirements of the DBA utility. An essential feature of the PCS 7 OS picture-tree is that it is a flat file space where objects are distinguished by unique names. This differs from many AS environments where objects may be distinguished by the resource with which they are associated and where tags and resources may not have unique names. The DBA utility helps reconcile tag naming conventions by providing the following: Automated folder naming mechanisms to allow PCS 7 OS tags derived from AS resources to have unique names. Functions that flag tags that PCS 7 OS would regard as duplicates. This gives you a chance to rename the tags as necessary to ensure that they are accounted for in the PCS 7 OS environment. The DBA utility also enables you to create virtual hierarchies consisting of operator stations and subordinate structures (folders and subfolders to a maximum of eight deep) to which you can assign AS objects. These hierarchies are automatically reflected in PCS 7 OS picture trees, graphic design program, and in the navigational scheme of activated PCS 7 OSs. The utility translates APACS+ HMI comments and tags to PCS 7 OS tags. The choices and hierarchies created in a DBA project can be saved to disk in.dba files for subsequent implementation or modifications. This enables you, for example, to make a slight modification to a controller configuration, recall the DBA session, load controller objects, and readily determine the changes that need to be made to the picture tree to accommodate the change. 8.2 Controller Objects See Loading (Updating) Controller Objects. Controller Object Filters The purpose of the Include All Resources and Include Assigned checkboxes is to provide listings that make it easy to list, sort, and find controller objects and corresponding OS tags. These listings appear under the headings that vary according to the AS. To sort, click the column heading of the characteristic of interest. Click the heading again to toggle between ascending and descending sorts. Siemens Industrial Spares A5E

62 Advanced Topics Include All Resources - list all controller objects loaded. To list objects for a specific controller, ensure that the checkbox is unchecked, and select the controller in the Controller objects list. Include Assigned - can be used in conjunction with Include All Resources, lists all controller objects for the selected resource, even if they have been assigned to the picture tree (if they have been assigned to the picture tree, they won't normally show up in the list unless this box is checked). Include Only Changes - list all controller objects that have changed (been added or modified) since the most recent update-controller-objects operation. If you Update Controller Objects then check this box and Update Controller Objects again, the list of controller objects is empty. Notice These checkboxes control how the program runs and are independent of individual projects. If you make changes to these checkboxes and exit the project, the changes remain in force when you reopen the project or open a different project. This is true even if you exit a project and elect not to save changes. 8.3 Checking for Duplicate and Missing Symbols The AS View Validation Results tab leads to a Validate function that identifies tags that are duplicate, missing or both (from the perspective of a PCS 7 OS). The function works on the current state of the symbols. The Compile function also checks for valid symbols and fails if it identifies symbols that are missing or duplicates. See Invalid Symbols Detected during Compile, below. To validate symbols: 1. Click the Validation Results tab. An empty window opens. 2. Click the Validate All button at the bottom of the window. The validate function runs and, if there are errors, reports them. The following are typical error messages generated when the function detects duplicate objects or missing objects. 8-2 A5E

63 Advanced Topics Clicking an error in the Validation Results window opens the plant view hierarchy as necessary to locate and display the tag that failed validation. Correcting Duplicate Object Errors The usual remedy for duplicate objects is to apply the techniques described in Ensuring Unique Object Names. Then click the Validation Results tab and click the Validate button again to ensure that the remedy worked. Correcting Missing Tags Errors The validate function also checks for missing tags, which are marked as objects not found in the controller. This includes changes to tag names, physical paths, or types. A missing-tag error can also be caused by selecting a different source option than the one used to create the current picture tree. Note that a tag can be both missing and duplicate. This can happen if an object has been removed from a controller and its name conflicts with another object's name. Missing tags are rendered in blue. Duplicated tags are rendered in red and must be resolved or the propagation fails. Invalid Symbols Detected during Compile In the case of a compile error, a Command Status... error message appears. When you close Command Status... error message, the window associated with Invalid Symbols is visible in place of the AS View: Siemens Industrial Spares A5E

64 Advanced Topics 8.4 Ensuring Unique Object Names PCS 7 OS plant view exists in a flat file system. The hierarchical structure of the plant view is a virtual hierarchy that relies on objects having unique names so they can be distinguished from one another and placed in hierarchical folders. The source AS system may not have this requirement and may be designed with a symmetrical naming convention that, while reasonable in the source OS, can lead to ambiguity in a flat file system. In these cases, uniqueness must be imposed on the AS structures. Sometimes the structures of the AS configurations are named in a way that requires no special efforts to ensure uniqueness. If you know at the outset that because of local naming conventions objects in the source AS environment would appear as duplicates in the PCS 7 OS environment, you can make systematic name changes in advance on a controller object-by-controller-object basis to conform to PCS 7 OS requirements. The Auto-Assigning Resources to the Plant View step includes a function for adding unique characters to AS objects. If controller objects contain identical structures and function blocks, usually a few characters of uniqueness text make it possible for PCS 7 OS to distinguish among them. When you right-click an AS resource and select the function Auto Assign Resources to the Plant View, the DBA Utility provides an opportunity to apply a prefix or suffix to the folder and picture names as they are created in the working template. Applying a prefix or suffix does not by itself create unique OS tag names. Having created opportunities of uniqueness, it is possible to apply folder names to controller objects using hierarchy settings. Hierarchy Settings The functions for controlling hierarchy settings are found by selecting File > Properties and the Hierarchy tab. The Hierarchy window opens. Functions invoked through this window create unique OS tag names. 8-4 A5E

65 Advanced Topics Here are descriptions of significant elements of the function. Max Level radio buttons determine the depth to which folders can be created. Max Characters field determines the number of characters permitted in folder names for folders created manually or renamed. But note that existing folder names are not truncated automatically if their name exceeds the Max Characters limit. Note also that the Max Level and Max Characters limitation do not apply to hierarchies created with the Auto Assign Resources to the Plant View button. Include in Name checkbox determines whether the folder name in the plant view is added to the OS tagname. With Separator A backslash character is an optional separator. A backslash is always inserted before the original tagname. When With Separator is checked, a backslash is inserted between folder names as well. OS Area determines a level in the hierarchy that is the root of the picture trees. This is derived from the plant hierarchy. In the illustration below, the OS Area checkbox selects Level 1. Level 1 corresponds in the plant view as Process Cell and Plant. The resulting PCS 7 OS shows Process Cell and Plant at the top of the hierarchy. In the illustration below, the OS Area checkbox selects Level 2. Level 2 corresponds in the plant view as React, Unit5, and PS_Batch, all of which sit at the second level below Process Cell and Plant. The resulting PCS 7 OS shows React, Unit5, and PS_Batch at the top of the hierarchy. Siemens Industrial Spares A5E

66 Advanced Topics 8.5 Importing and Exporting the Plant View The plant hierarchy in the Plant View can be exported to a CSV file or imported from a CSV file using the context menu as shown below: 8-6 A5E

67 9 Configuring APACS+ for Use with DBA 9.1 DBA Utility Capabilities The DBA utility propagates offline APACS+ controller configuration information into PCS 7 OS target offline databases. The propagation automatically exports the APACS+ controller configurations using 4 mation and automatically imports the changes into the PCS 7 OS target configurations. No manual steps are required. The following figure illustrates the flow of information from APACS+ to PCS 7 OS: The propagation supports the creation of the following OS object types: Single Tags (both Internal and External) Structured Tag Definitions Structured Tag Instances Alarms / Messages Graphics Symbols Plant View The configuration of the DBA utility involves the following 5 steps: 1. Add HMI Comments to the APACS+ controller configuration using 4-mation. 2. Create Defined Type Files for any custom structured types using the DTF Editor utility. 3. Create a DBA project and add the appropriate APACS+ controller configurations as sources using the DBA utility. 4. Create a Plant View and assign the controller objects (marked by 4-mation HMI Comments) to the appropriate Plant View Folder. 5. Define the PCS 7 OS targets to be modified and assign them to plant view folders. This section describes the first two steps in this process, defining an HMI Comment in 4-mation and building a Defined Type File. Siemens Industrial Spares A5E

68 Configuring APACS+ for Use with DBA The following table defines terms used within this section: Term 4-mation HMI Comment Individual Variable HMI Comment Structured Variable HMI Comment Defined Type File Defined Type Instruction Comment Defined Type Variable Comment Defined Type Message Comment Individual OS Variable Structured OS Variable Structured OS Variable Type Definition A standard 4-mation comment with a very specific format. It can be entered on any 4 mation configuration sheet type except structured text. There are two categories of 4-mation HMI Comment: Individual Variable HMI Comment Structured Variable HMI Comment A 4-mation HMI Comment or Defined Type Variable Comment that defines an Individual OS Variable to be created in the OS. Not all attributes are supported when used as a 4-mation HMI Comment. A 4-mation HMI Comment that defines a Structured OS Variable to be created in the OS. The TYPE attribute must be defined and reference a valid Defined Type File. A formatted ASCII file that defines a Structured OS Variable Type and associated Messages. The file consists of the following formatted lines: Defined Type Instruction Comment Defined Type Variable Comment Defined Type Message Comment A line in a Defined Type File that provides instructions other than variables and messages to the DBA utility during the propagation process lines to include other Defined Type Files). A line in a Defined Type File that specifies an attribute of an OS structure. Every instance of the structured OS tag creates a single OS tag with the following name: StructuredTagName.AttributeName where the StructuredTagName is the name of the structured tag and AttributeName is the name of the attribute created by the Defined Type Variable Comment. A line in a Defined Type File that specifies a message in the OS. Every instance of the structured OS tag creates a message associated with that particular instance. A single tag in the OS created in response to Individual Variable HMI Comments either as 4-mation HMI Comments or as Defined Type Variable Comments. A structured tag in the OS created in response to Structured Variable HMI Comments. A structured tag definition in the OS. One structured OS tag definition is created in response to multiple Structured Variable HMI Comments that have the same TYPE attribute mation HMI Comments An HMI Comment is a standard 4 mation comment with a specific format. An HMI comment can be entered on any 4-mation configuration sheet type except structured text. HMI Comments make reference to either individual variables or defined-type variables. HMI comments are entered in the cells of the sheet by bracketing the comment text with asterisk characters and parentheses (*and*). Comments appear in the cell as follows, with no space after the opening asterisk and no space before the closing asterisk: 9-2 A5E

69 Configuring APACS+ for Use with DBA (*comment text*) The HMI comment text general syntax is as follows: HMI:source{{:attribute=parameter}...} where the information in braces is optional and the colon (:) separated fields consist of the following: The first field contains the characters HMI and is required. The second field contains the source of the OS variable and is also required. Optional additional fields contain attribute information for the variable. Notice 1. The ionub characters "[" and "]" and the user-defined global variable characters " " and " " are not required for communications. However, they should be used in the HMI comments to aid in identifying the type of variable since they are used and seen when referencing the variables in the 4-mation software. The iochan "%", the embedded global variable character "#", and the array element characters "[" and "]" are required for communications and must be used. See Variable Source Syntax. 2. Note that only the comment text appears in the edit field above the cells in 4-mation in the form of attribute=parameter. The comment delimiters are not visible. Except for I/O channel or global variables, the HMI comment should refer only to variables or standard function blocks on the sheet containing the HMI comment. Although it is possible to refer to variables on other sheets if their path is started at the program level, using this syntax should be avoided for two reasons: The variable type cannot be determined, which could possibly produce an incorrect reference to the variable. The HMI comments become very long and difficult to read The following image shows an example of a Structured Variable HMI Comment in 4-mation for the SINGLE_LOOP function block: Siemens Industrial Spares A5E

70 Configuring APACS+ for Use with DBA 9.3 Configuring 4-mation for Individual OS Variables Individual OS Variables typically reference the following: local variables user-defined or embedded global variables standard or derived function block I/O nubs standard function block softlist parameters I/O channel variables I/O channel softlist parameters These variables require the manual entry of an Individual Variable HMI Comment in 4-mation. An Individual Variable HMI Comment requires the source and TYPE attribute. The TYPE value can be any APACS+ data type name (e.g., BOOL, REAL, LONG, SINT, USINT, INT, etc.) or any IO Channel type name (e.g., SDIC, ADIC, SDOC, SAIC, etc.). Other attributes can be added based upon the value of the TYPE attribute. See the Variable Attribute Syntax section for a listing and description of the valid attributes. Notice In the HMI comment, BOOL can be replaced by DISCRETE to create a structured WinCC variable instead of individual WinCC variables. This can be useful, for example, if you want to apply security restrictions to the variable, since security can only be enforced on variables that are part of a structure. Similarly, for any analog types (e.g., REAL, LONG, INT, etc.), the type in the HMI comment can be replaced with ANALOG to create a structured WinCC analog variable instead of an individual WinCC analog variable. Finally, for any of the string types (STRING_8, STRING_16, STRING_32, STRING_64, STRING_128), the type in the HMI comment can be replaced with STRING to create a structured WinCC string variable instead of an individual WinCC string variable. 9-4 A5E

71 Configuring APACS+ for Use with DBA Example 1: Configure an Analog Tag This example illustrates how to configure 4-mation to create an Individual OS Variable that references a controller analog IO Variable with the following attributes: Single OS tag created with the name PI_1000 and some engineering range Two (2) Internal tags created as follows: PI_1000#comment references the text table entry with the descriptor string PI_1000#unit references the text table entry with the units string. There are several ways to configure 4-mation so that the DBA utility creates the required single OS tag. Solution 1: The first solution is to configure a single 4-mation HMI Comment that contains all the required attributes as follows: (*HMI:%PI_1000:TYPE=REAL:DESC=Flow pressure: ENGH=>%PI_1000.MaxScale:ENGL=>%PI_1000.MinScale: UNITS=>%PI_1000.EngUnits*) Notices This comment is a single line within 4-mation. The OS tag name is PI_1000 since the TAG / ALIAS attribute was not specified. The I/O channel description entered in the 4-mation Configuration software is not available as a softlist parameter and therefore cannot be referenced using the ">" syntax for the DESC attribute. However, the ENGH, ENGL, and UNITS are obtained from the IO channel softlist values. Solution 2: The second solution is to configure several 4-mation HMI Comments with the same source field value as follows: (*HMI:%PI_1000:TYPE=REAL:DESC=Flow pressure*) (*HMI:%PI_1000:ENGH=>%PI_1000.MaxScale*) (*HMI:%PI_1000:ENGL=>%PI_1000.MinScale*) (*HMI:%PI_1000:UNITS=>%PI_1000.EngUnits*) When multiple HMI comments are written, the source field in each case must be identical. Solution 3: The third solution is to configure a single 4-mation HMI Comment of the TYPE "SAIC" and is as follows: *HMI:%PI_1000:TYPE=SAIC:DESC=Flow pressure*) The I/O channel type codes can be obtained from the [CHAN_TYPE_DEFS] section of the APACS MODULE.INI file. Siemens Industrial Spares A5E

72 Configuring APACS+ for Use with DBA Notice Note PCS 7 OS Option DBA automatically configures the ENGH, ENGL, and UNITS when this method is used. Solution 4: The fourth solution works only for I/O Channels and does not require any 4- mation HMI Comments. In the 2 Define Picture Tree DBA configuration step, check the Auto-Generate I/O Tags checkbox and then press the Load Controller Objects button. This button processes the APACS+ controller configuration and builds the list of controller objects that is displayed in the Controller Objects list box. All the IO Variables are included in the list, allowing any one or more IO variables to be assigned to the picture tree. This solution automatically configures the DESC, ENGH, ENGL, and UNITS from the appropriate IO Channel softlist values. Example 2: Configure a Discrete Tag This example illustrates how to configure 4-mation to create an Individual OS Variable that references a controller discrete variable with the following attributes: Single OS tag created with the name Loop100_OOS Two (2) Internal tags created as follows: - Loop100_OOS#comment references the text table entry with the descriptor string. - Loop100_OOS#unit references the text table entry with the units string. - Loop100_OOS#string_0 references the text table entry with the descriptor string for the off state. - Loop100_OOS#string_1 references the text table entry with the descriptor string for the on state. Solution: The first solution is to configure a single 4-mation HMI Comment that contains all the required information: (*HMI:.OOS:TAG=Loop100_OOS:TYPE=BOOL:DESC=Motor100 Out of Service:OFF=Out Of Service:ON=In Service*) Notice This comment is a single line within 4-mation and placed on a sheet that has a discrete local variable called OOS Other examples of Individual Variable HMI Comments (*HMI:LAST_COUNT:TYPE=INT:ENGH=500:ENGL=0*) (*HMI:#SystemOK:TYPE=BOOL:ALIAS=AREA1_CONTROLLER_OK*) 9.4 Configuring 4-mation for Structured OS Variables Structured Variable HMI Comments define a Structured OS Variable. The APACS+ application library blocks and optional function block library blocks 9-6 A5E

73 Configuring APACS+ for Use with DBA make extensive use of this type of comment. Since the application library blocks include the Structured Variable HMI Comment, manual entry is not required. The Structured Variable HMI Comment typically specifies the sheet as the source and the derived function block type as the variable type. For example: (*HMI:.:TYPE=SINGLE_LOOP:REV=4.00*) If the derived function block instance name containing the Structured Variable HMI Comment is TC_1000, the tag name for the.[pv] variable is TC_1000-PV. The engineering scale values, descriptor, and units for TC_1000-PV are obtained from the specified standard function block softlist parameters. The other variables are named and initialized as specified in the remaining HMI comments. The TYPE specified in the Structured Variable HMI Comment in 4-mation does not have to match the actual function block type name, such as would be the case for derived function block types that are duplicated, as long as the actual Defined Type Variable Comment remains the same. For example, if the SINGLE_LOOP derived function block is copied for multiple uses, each with its own new function block type, the Structured Variable HMI Comment does not have to be modified. If, however, the derived function block is copied and modified such that the Defined Type Variable Comments are different, the sheet HMI comment TYPE= attribute must be edited to reflect the new function block type. In this case, the original defined-type file can also be copied to a new defined-type file corresponding to the new function block type and the variable list modified as necessary. 9.5 Defined Type File Layout and Syntax A Defined Type File is an ASCII file that defines a Structured OS Variable Type and associated Messages. The file consists of instruction comments, variable comments, and message comments. The following listing is from the SINGLE_LOOP.HMI Defined Type File and creates an OS structured tag type called SINGLE_LOOP_AFB: Line Code 01 ;DEFINEDTYPE:SINGLE_LOOP 02 ;SCHEMAVERSION: [ PCS 7] 04 HMI:TAG_STRUCTURE=SINGLE_LOOP_AFB HMI:"SINGLE_LOOP_AFB":TAG=#blocktype:TYPE=TEXTREF 07 HMI::TAG=#areaname:TYPE=TEXTREF 08 HMI:@StripEnclosingApostrophes(VALUE;.DESC.VALUE):TAG =#comment:type=textref 09 HMI::TAG=#graphic:TYPE=TEXTREF 10 ; Include common controller information HMI:@INCLUDE(CONTROLLER_COMMON[ PCS 7]) 13 ; Include alarm mapping information HMI:@INCLUDE(ALARM_MAP[ PCS 7]) Siemens Industrial Spares A5E

74 Configuring APACS+ for Use with DBA Notice The line numbers in the code sample provided above are included only for reference and do not appear in the actual Defined Type File Defined Type Files can be viewed and changed using any standard ASCII file editor or the Defined Type File Editor. The Defined Type File Editor can be started by selecting Start > Programs > Simatic > DBA >Defined Type Editor. See Defined Type File Editor. Defined Type Name Directive The Defined Type Name directive is a specially formatted comment line that is required by the DBA utility. It must be of the following syntax (no spaces are allowed): ;DEFINEDTYPE:SomeName where SomeName is replaced with the string that represents the name of the Defined Type File. This is the string that is defined in the TYPE attribute of the Structured Variable HMI Comment. This string value MUST match the name of the Defined Type File as follows: SomeName.HMI Schema Version Directive The Schema Version directive is for internal use only and must follow the Defined Type Name directive and must be of the following syntax (no spaces are allowed): ;SCHEMAVERSION:1.0.0 Structure Definition Product and Version A Defined Type File can define structures for multiple products and versions. This allows a single Defined Type File to generate different OS structures based on the source function block version (e.g. Revision 3.00 should be different from Revision 4.00 of the application libraries). The 6.0 release of the APACS+ PCS 7 OS Option DBA utility requires that the product string be 6.0 PCS 7 as shown in line 03 of the example. Structured Tag Type Name Directive The name of the OS structured tag type is declared using the Structured Tag Type Name directive as follows: HMI:TAG_STRUCTURE=SomeName where SomeName is replaced with the string that represents the name of the OS structured tag type. This value can be different than the Defined Type Name directive as shown in the example. No spaces are allowed in this line and SomeName must be a valid OS structured tag type name. 9-8 A5E

75 Configuring APACS+ for Use with DBA Comment Directive Any line that starts with a semicolon (;) is considered a comment and is ignored by the DBA utility. The only exclusions to this rule are the special Defined Type Name and Schema Version directives. Include Directive Any line that starts with HMI:@INCLUDE is an include directive. The include directive is used to create modular defined type files. Every include directive line in a defined type file line is replaced with the contents of the specified section of the specified defined type file. The include directive includes the specification of the specific product and version of the section to include and uses the following syntax: HMI:@INCLUDE (FileName [ProductVersion - Product]) where FileName is the name of the defined type file to insert (without extension) and Product and ProductVersion define the section to use. The included file can also contain include directives. The DBA utility supports nesting of include directives to a maximum of five levels deep. The HMI file for a single-loop controller, for example, includes by reference two other HMI files as shown by lines 12 and 16. The included Defined Type File needs to exist in the same directory as the including file, normally in the C:\Program Files\Siemens\Obj\APACS+\Templates directory. Declaring a Templates Folder for Custom Defined Types To declare a templates folder to store custom Defined Type Files: 1. In the plant view, select the root folder. The Project Template Folders attribute appears: 2. Enter the desired folder name into the Value column. If a folder is specified for Defined Type Files, the DBA utility program looks for templates in this folder before looking into the basic templates folder in \DBA\APACS\Templates. Siemens Industrial Spares A5E

76 Configuring APACS+ for Use with DBA 9.6 Defined Type Variable Comment Syntax Attribute variables of a Defined Type File are defined using the same syntax as Individual Variable HMI Comments. The Defined Type Variable Comment syntax is as follows: HMI:source{{:attribute=parameter}...} where the information in braces is optional and the colon (:) separated fields consist of the following: The first field contains the characters HMI and is required. The second field contains the source of the OS variable and is also required. Optional additional fields contain attribute information for the variable. The Defined Type Variable Comment must be contained on a single line in the Defined Type file. There is no line continuation support. The source and parameter fields can be functions and use the Defined Type File Function syntax This is described in the Built-in Functions and User Defined Functions sections. 9.7 Defined Type Message Comment Syntax PCS 7 OS Alarms / Messages are defined in a Defined Type File using the Message Comment using the following syntax: MSG:message:attribute=parameter:... where multiple attribute / parameter pairs are separated by a colon (:) and consist of the following: The first field contains the characters MSG and is required. The second field contains the string value of the Message and is also required. Additional fields contain attribute information for the message some of which are required. The following table lists the attributes supported for PCS 7 OS messages: Attributes for All Variables AlarmType= the type of alarm the message is describing. This field does not limit the other attribute values and is only provided to help the user when configuring Defined Type Files. Class= the class of the message. The value of this attribute depends on the class of the message that you would like to use. The following are the default classes provided when the OS Project Editor is used during the creation of your WinCC Project. (Refer to Creating a New WinCC Project for details.) Refer to the table below for the class that you would like to use. Once you have selected a class, formulate the "Class=" entry in the defined type file by entering the description specified in the table. For example, if you would like to use class 3, Tolerance, specify Class="Tolerance". [Note: The possible classes are ultimately dependent on the Alarm Logging configuration of your WinCC Project. If you have changed the list of available classes, use the Alarm Logging configuration tool in WinCC Explorer to determine which classes are available 9-10 A5E

77 Configuring APACS+ for Use with DBA Class Description 1 Alarm 2 Warning 3 Tolerance 4 PLC Process Control Messages 5 OS Process Control Message System 6 Preventive Maintenance 7 Process Message 8 Operating Message 9 Request for Operator Input 10 Operator Input Message 16 Status Message 17 System, must be acknowledged 18 System, need not be acknowledged Type= the type of the message. The value of this attribute depends on the class of the message and the type within the class that you would like to use. The following are the default types, along with their associated classes, provided when the OS Project Editor is used during the creation of your WinCC Project. (Refer to Creating a New WinCC Project for details.) Refer to the table below for the type that you would like to use. Once you have selected a type, the "Type=" entry in the defined type file is constructed as follows: add the "Message Type" number from the table entry to the word "Type". For example, if you would like to use as "Tolerance High" the type, select Class="Tolerance" and Type="Type37" (note that there are no spaces between the word "Type" and the Message Type number (in this example, 37). Note: The possible types that are available for each class are ultimately dependent on the Alarm Logging configuration of your WinCC Project. If you have changed the list of available types for one or more classes, use the Alarm Logging configuration tool in WinCC Explorer to determine which types are available for each class. Class Message Type Description 1 1 Alarm High 1 2 Alarm Low 2 19 Warning High 2 20 Warning Low 3 37 Tolerance High 3 38 Tolerance Low 4 55 System 4 56 Error 5 71 System 5 72 Error 6 89 Maintenance Process Message Process Message Request for Operator Input Operator Input Message Status PLC Status OS Process control system Siemens Industrial Spares A5E

78 Configuring APACS+ for Use with DBA System messages Process control system Operator input message MessageTag= the data manager tag name that defines the runtime state of the message. Usually set to an internal DWORD tag called EventRaw#1. The tag defined in CalcMsgTag is used as the source tag to drive the value of EventRaw#1. If an external tag is used directly, the Alarm Lock feature will not work. CalcMsgTag= the message source tag used to generate messages outside of the controller. See the section titled Generating Alarms Outside of the Controller for more details and an example. CalcMsgBit= the bit position or specific condition of the CalcMsgTag that will trigger a message. See the section titled Generating Alarms Outside of the Controller for more details and an example. MessageBit= the bit of the MessageTag value that triggers the message. AckTag= the data manager tag name that is used at runtime to acknowledge the message. Usually set to an internal DWORD tag called EventAck#1. The tag defined in CalcAckTag attribute is the target tag driven by the value of EventAck#1 AckBit= the bit of the AckTag that is set when acknowledged. CalcAckTag= the message acknowledgement target tag used optionally to acknowledge messages outside of the controller. See the section titled Storing Alarm Acknowledgements and Alarm Lock Outside the Controller for more details and an example. CalAckBit= the bit position or specific condition of the CalcAckTag that will acknowledge the message. See the section titled Storing Alarm Acknowledgements and Alarm Lock Outside of the Controller for more details and an example DisableTag= internal tag that's used to suppress a message. Usually set to an internal DWORD tag called EventDisable#1. This attribute must be provided if CalcMsgTag and/or CalcAckTag attributes are used, even if this tag is not used in the HMI to suppress the message. The high word of this tag causes the Alarm Lock status to be persisted and synchronized. If the Alarm Lock feature is used, this attribute must be provided as well. DisableBit= the bit of the DisableTag value that suppresses the message. Invert= any non-zero value inverts the message triggered when the message bit defined by MessageTag and MessageBit attributes is 0 instead of 1. If this attribute is not provided, by default, the message will be triggered when the message bit is 1. message field or EventText= the text of the message. Displayed as the Event column in the Alarm Logging tool in PCS 7 OS. This can include replacement strings. ChargeName= this optional field is displayed as the Batch Name column in the Alarm Logging tool in PCS 7 OS. Operation= this optional field is displayed as the Operation column in the Alarm Logging tool in PCS 7 OS. Freen= this optional field is displayed as the Freen column in the Alarm Logging tool in PCS 7 OS where n is replaced with A5E

79 Configuring APACS+ for Use with DBA ProcessValuen= this optional field is displayed as the ProcessValuen column in the Alarm Logging tool in PCS 7 OS where n is replaced with The area text of the message is automatically defined by the value of the #areaname structured variable HMI comment. This value cannot be changed manually. 9.8 Defined Type Extended Attribute Comment Syntax An Extended Attribute is an attribute of a variable that is exposed to the user so the user can change the value through DBA s graphical user interface. Extended Attributes are defined in a Defined Type File using the Extended Attribute Comment using the following syntax: EXA:description:attribute=value:... where multiple attribute / value pairs are separated by a colon (:) and consist of the following: The first field contains the characters EXA and is required. The second field contains description of the Extended Attribute. Additional fields contain attribute information for the Extended Attribute some of which are required. The following table lists the supported Extended Attributes: AttributeName= name of the extended attribute. Required. DisplayName= the alias of the extended attribute that will actually display in the DBA s GUI. AttributeName value is used if not provided. Category= category to group different kinds of extended attributes. Required. Type= type of the extended attribute value. Required.The following types and APACS+ standard data types can be used as the value: Type Integer Int Boolean Bool String Str Float Enumeration Description nteger type Same as Integer Boolean type Same as Boolean String type Same as String Floating point type Enumeration type Value= the initial value of the extended attribute. Required. Permission= RO for read only. RW for read and write. Assumed RO if not provided. Visible= the value -1 makes the extended attribute visible in the GUI. The value 0 makes it invisible. Assumed visible if not provided. MinInclusive= used only when Type is Integer or Float. Minimum possible value of the extended attribute. MaxInclusive= used only when Type is Integer or Float. Maximum possible value of the extended attribute. Siemens Industrial Spares A5E

80 Configuring APACS+ for Use with DBA Values= used only when Type is Enumeration. List of enumerators separated by commas. Value has to be one of these enumerators. Required when Type is Enumeration. Enumeration= optionally used only when Type is Enumeration. Actual enumerator values are separated by commas when the enumerators in Values are used as place holders for display purpose. For example:values=man,auto,com:enumeration=0,6,8: If Auto is selected as the value, it will be replaced with 6 during the compile. The number of enumerators must be the same as the number of Values attributes. The Enumeration attributes in the above example make clear the connection between Man,Auto,Com and 0,6,8. VariableLink= name of the tag whose start value will be replaced by the value of Value attribute during the compile. Example The following EXA Comment, extracted from SINGLE_LOOP.HMI, adds the DecimalPlacesPV attribute to the DBA. This addition makes it possible to assign the start value of DecimalPlacesPV tag: EXA:"PV Decimal Places To Display":Category="Graphics":AttributeName=DecimalPlacesPV:Valu e=2:type=integer:mininclusive=0:maxinclusive=6:permission=rw:vi sible=-1:variablelink=decimalplacespv: 9.9 Generating Alarms Outside the Controller Analog and discrete alarms can be generated by using an internal tag as the MessageTag and mirroring this internal tag with a source tag and condition of the source tag using the CalcMsgTag and CalcMsgBit attributes respectively. Example If the following attributes and values are used, a PV tag value greater than 50 triggers the analog alarm: MessageTag=EventRaw#1:MessageBit=12:CalcMsgTag=PV:CalcMsgBit=AN ALOG;GT;50: CalcMsgTag can be any analog or discrete tag. CalcMsgBit has the following formats depending on the type of the alarm condition: Bit Type Bit Alarm Condition Type: CalcMsgBit=<bit position starting from 0>;<optional bit value default is 1> 9-14 A5E

81 Configuring APACS+ for Use with DBA Examples: CalcMsgBit=3;0 when the 4th bit of CalcMsgTag value is 0 CalcMsgBit=0 when the 1st bit of CalcMsgTag value is 1 Boolean Type Boolean Alarm Condition Type: CalcMsgBit=BOOL;<boolean value 0 or 1> Examples: CalcMsgBit=BOOL;0 when CalcMsgTag value is 0 CalcMsgBit=BOOL;1 when CalcMsgTag value is 1 Integer Type Integer Alarm Condition Type: CalcMsgBit=INT;<comparator>;<integer value or tag name (.tagname if the tag is a member variable of the structured tag)>;mask=<optional mask> Supported Comparators: LT - Less Than Value. LE - Less Than or Equal Value. GT - Greater Than Value. GE - Greater Than or Equal Value. EQ - Equal Value. NE - Not Equal Value. VLT - Less Than Variable Tag Value. VLE - Less Than or Equal Variable Tag Value. VGT - Greater Than Variable Tag Value. VGE - Greater Than or Equal Variable Tag Value. VEQ - Equal Variable Tag Value. VNE - Not Equal Variable Tag Value. Examples: CalcMsgBit=INT;LT;90 when CalcMsgTag value is less than 90 CalcMsgBit=INT;VEQ;.CompareTag;Mask=15 when first four-bits masked value of CalcMsgTag is equal to the value of CompareTag tag. The start value of this comparing tag can be user configurable using an extended attribute as described in the section titled Defined Type Extended Attribute Comment Syntax. Analog Type - Analog Alarm Condition Type: CalcMsgBit=ANALOG;<comparator>;<floating point value or tag name (.tagname if the tag is a member variable of the structured Siemens Industrial Spares A5E

82 Configuring APACS+ for Use with DBA tag)>;deadband=<optional deadband>;deviation=<required if the comparator is a Deviation type (AD, HD, LD, VAD, VHD, VLD)> Supported Comparators: Same as the comparators of integer (INT) type except for the following additions: AD Absolute Deviation from Value. HD High Deviation from Value. LD Low Deviation from Value. VAD Absolute Deviation from Tag Value. VHD High Deviation from Tag Value. VLD Low Deviation from Tag Value. See the section titled Storing Alarm Acknowledgements and Alarm Lock Outside of the Controller Storing Alarm Acknowledgements and Alarm Lock Outside the Controller To store alarm acknowledgements and alarm status outside the controller: 1. On the APACS+ Controller Configuration dialog box, clear the checkbox labeled Write Alarm Acknowledgements and Alarm Lock Status to the Controller: 2. Execute Update Controller Objects whenever this option is changed. This option can be changed on a per-controller basis. After this box in cleared, all defined type files of the standard blocks that store the alarm acknowledgement and alarm lock status in the controller are configured to store this information outside the controller. The following subsections describe how to make a custom Defined Type File to take advantage of this feature A5E

83 Configuring APACS+ for Use with DBA Conditionally Writing an Alarm Acknowledgement to a Controller: 1. Create an internal alarm acknowledgement tag. Ensure that it is synchronized and persisted: HMI::TAG=EventAck#1:TYPE=DWORD:VarProperty=2:Persist="RSTA=Eve ntcalculator":sync="rsta=eventcalculator": 2. Use the internal tag as the AckTag and assign the actual controller acknowledgement tag to the CalcAckTag attribute. 3. Use CalcAckBit attribute to determine the controller acknowledgement tag when the alarm is acknowledged. In the following example, attributes in the message comment make the alarm acknowledgement write 0 to the NAK1 tag: AckTag=EventAck#1:AckBit=0:CalcAckTag=NAK1:CalcAckBit=BOOL;0: The format of CalcAckBit attribute is the same as CalcMsgBit attribute but only Bit and Boolean types are supported for CalcAckBit. When the Write Alarm Acknowledgements and Alarm Lock Status to the Controller check box is not checked, CalcAckTag and CalcAckBit attributes are ignored and the alarm acknowledgement is stored only in the internal alarm acknowledgement tag. Conditionally Writing Alarm Lock status to the Controller: Special hidden Extended Attributes called EventLockTag1 and EventLockTag2 specify the tags the Alarm Lock status gets written to. Either EventLockTag1 or EventLockTag2 or both can be used to specify the controller tag or tags that the Alarm Lock status is written to. The following example shows the format of these Extended Attributes: EXA:"Controller Event Lock Tag 1":Category="ControllerEventLockTag":AttributeName=EventLoc ktag1:value=p_oos:type=string:visible=0: EXA:"Controller Event Lock Tag 2":Category="ControllerEventLockTag":AttributeName=EventLockTag 2:Value=S_OOS:Type=String:Visible=0: The Alarm Lock status is written to P_OOS and S_OOS tags in this example. When the Write Alarm Acknowledgements and Alarm Lock Status to the Controller check box is cleared, Extended Attributes of category ControllerEventLockTag are ignored, and the Alarm Lock status will be available only to the OS. The high words of the alarm disable tags declared by DisableTag and DisableBit attributes in the message comments are actually used to persist and synchronize the Alarm Lock status. For this reason, the alarm disable tag always has to be DWORD type and synchronized and persisted. DisableTag and DisableBit attributes are required in each message comment if CalcMsgTag and/or CalcAckTag attributes are used or the Alarm Lock feature is used Function in a Defined Type File Defined Type File comment lines can call functions to determine the source and parameter values. The syntax used to execute a function is as Siemens Industrial Spares A5E

84 Configuring APACS+ for Use with DBA where FunctionName is the name of the function and parameter is one or more parameters. A function can be one of the built-in Defined Type File Functions or a User Defined Function. All functions return a value that is used for that field or parameter. The function logic is defined in the VBScript language and must be XML compliant. Parameters to a function can be passed as described in the following table: Parameter Type CONSTANT VALUE ADDRESS Description The text following the semicolon is passed as a string and is not interpreted. The text following the semicolon is used to find a value from the AS configuration relative to the source field of the Defined Type File. The text following the semicolon is used to construct the APACS+ Communications System Tag Name. A parameter type is specified by prefixing the parameter with one of the parameter types followed by a semicolon (;). For example, the first parameter of the following function call is passed to the function as a constant and is not to be interpreted as anything else: SelectCase4(CONSTANT;HIGH_HIGH,VALUE;.ALARM.ALARM1_TYPE, ADDRESS;.ALARM.ALARM1_LIMIT) The second parameter of the example is converted to the specific value of the AS controller object before calling the function. In this case, the value of the ALARM1_TYPE softlist value of the ALARM block on the current sheet is passed. The third parameter of the example is converted to the APACS+ Communication System Tag Name before calling the function. For example, if the current sheet is ACM1.Sheet1.Sheet2, then the third parameter would be ACM1.Sheet1.Sheet2.ALARM.ALARM1_LIMIT The first parameter to any function is hidden and provides a reference to the Node that is being processed. This is commonly referred to as the this pointer or reference. The DBA utility converts the Defined Type File into an XSL file before applying it to any 4 mation HMI Comment. This process of converting the Defined Type File into XSL is called compiling. The Defined Type File only needs to be compiled once no matter how many 4 mation HMI Comments reference it. Applying the compiled Defined Type File to an instance of a 4-mation HMI Comment involves the XML transformation of the XML node within the exported AS configuration. The functions of the Defined Type File make use of the XML node and its relatives. An understanding of the 4 mation XML export format is required to write significant custom functions and is not described in this document Built-In Defined Type File Functions There are several built-in functions that are used by the Defined Type Files for the Standard Function Block Libraries, but can be used by any Defined Type File. The list of Built-In Defined Type File functions follows: 9-18 A5E

85 Configuring APACS+ for Use with DBA Function Syntax GetResourceName (sexpression ) IfExistsThenElse ( stestexpression, sstatement, selsestatement) IfThenElse4 (stestexpression, sexpression1, sexpression2, sexpression3, sexpression4, sstatement, selsestatement) SelectCase4 (stestexpression, sexpression1, sexpression2, sexpression3, sexpression4, sstatement1, sstatement2, sstatement3, sstatement4, selsestatement) CalcEventTrans (sexpression1, sexpression2, sexpression3, sexpression4) ForceEventTrans ( sexpression1, sexpression2, sexpression3, sexpression4) CalcURL ( slowlimit, shighlimit, smultiplier) CalcLRL ( slowlimit, shighlimit, smultiplier) CalcSpan ( slowlimit, shighlimit, smultiplier) Description Returns the resource name of the passed address string. Evaluates the stestexpression as a valid XPath expression relative to the current node and returns sstatement if available, or selsestatement if not available. Compares the stestexpression against the given expressions (sexpression1-4) and returns sstatement if any match is found, otherwise returns selsestatement. Compares the stestexpression against the given expressions (sexpression1-4) and returns sstatement1 if matching sexpression1, sstatement2 if matching sexpression2, and so on. If none matches, then the function returns selsestatement. Returns the #EventTrans value based on the given expressions based on APACS+ ALARM function block alarm types. The possible values include: HIGH, LOW, HIGH_DEV, LOW_DEV, ABSOLUTE_DEV, OUT_OF_RANGE, QUALITY_NOT_GOOD, HIGH_HIGH, LOW_LOW, INC_ROC, DEC_ROC, and ABS_ROC. Returns the #EventTrans value required for the given PCS 7 OS message type. The possible values include: HIGH_ALARM, LOW_ALARM, HIGH_WARNING, LOW_WARNING, HIGH_TOLERANCE, LOW_TOLERANCE, SYSTEM, FAILURE, and PROCESS. Returns the Upper Range Limit based on the given parameters. The computation is as follows: slowlimit + ((ABS(sHighLimit - slowlimit)) * smultiplier) Returns the Lower Range Limit based on the given parameters. The computation is as follows: slowlimit - ((ABS(sHighLimit - slowlimit)) * smultiplier) Returns the span based on the given parameters. The computation is as follows: ((ABS(sHighLimit - slowlimit)) * smultiplier StripEnclosingApostrophes Returns the passed value without the enclosing (sexpression) apostrophes. This is useful because all strings in 4 mation include enclosing apostrophes. Siemens Industrial Spares A5E

86 Configuring APACS+ for Use with DBA For examples of how these functions are used, please see the Defined Type Files for the Standard Function Block Library User Defined Functions A User Defined function can be added to the Defined Type File in the Script Section. The script section is marked by the [SCRIPT:VBScript]... [/SCRIPT] syntax and illustrated in the following example: Line Code 01 [SCRIPT:VBScript] 02 Function GetCurrentDate(oThis) 03 Return the current date as a string. 04 GetCurrentDate = CStr(Now()) 05 End Function 06 Function CalcVolume(oThis, slength, swidth, sheight) 07 CalcVolume = slength * swidth * sheight 08 End Function [/SCRIPT] In this example, line 01 and 10 indicate the start and end lines of the script block. There can only be one (1) script block per Defined Type File. The function names must be unique among all script functions defined in all included files. The text in the script block must be VBScript. The first parameter must be othis. This is a reference to the CBOTEXT XML node that is being propagated, however it does not have to be used. The example GetCurrentDate() function uses the VBScript function Now() to return the current time. The CalcVolume() function takes three (3) dimensions and calculates the volume. The script could even access an external COM object using the VBScript CreateObject() function including the ActiveX Data Object (ADO) object to read a database. Using a namespace, a script in an HMI file can be run within its own scope, so scripts on different included HMI files will not conflict. For example, the following text can be added to the end of an HMI file to define functions to be executed during the Update Controller Objects call: [SCRIPT:VBScript:SM] function FixUpAddress(nodelist,sPathToBlock,sAddress) FixUpAddress = "$XXXXXXX$." & saddress end function [/SCRIPT] The functions can be invoked during the resolution of the APACS address for each HMI lines as follows: HMI:@SM.FixUpAddress(.,.EffectStat):TAG=E_ST65_128:TYPE=RAW: Notice that the script block defined the script namespace as SM. Therefore it is required to specify the namespace in the function call. Also notice that the first 9-20 A5E

87 Configuring APACS+ for Use with DBA parameter is implicit in the function specification to be the 'this' pointer back to the HMI Comment Variable Source Syntax The source field of the HMI Comment syntax HMI:source{{:attribute=parameter}...} specifies the reference as one of the following: Local variable User-defined or embedded global variable Standard or derived function block I/O nub Standard function block softlist parameter I/O channel variable I/O channel softlist parameter Standard or derived function block as the source of a Structured Variable HMI Comment The following table lists the syntax required to reference the desired controller object: Variable.localvar.localvar[element] globalvar globalvar [element] #globalvar.[ionub].[ionub][element].fbinst.param.fbinst.[ionub].fbinst.[ionub][element] %iochan Description Individual local variable on current sheet Default alias: localvar Individual local variable array element on current sheet Default alias: localvar_index1{{_index2}...} Individual user-defined global variable Default alias: globalvar Individual user-defined global variable array element Default alias: globalvar_index1{{_index2}...} Individual embedded global variable Default alias: globalvar Requires TYPE= attribute Individual I/O nub on current sheet. Default alias: ionub Individual I/O nub array element on current sheet Default alias: ionub_index1{{_index2}...} Individual softlist parameter of function block on current sheet Default alias: fbinst.param Requires TYPE= attribute Individual I/O nub of function block on current sheet Default alias: fbinst.[ionub] Requires TYPE= attribute Individual I/O nub array element of function block on current sheet Default alias: fbinst.[ionub]index1{{_index2} } Individual I/O channel variable Default alias: iochan Siemens Industrial Spares A5E

88 Configuring APACS+ for Use with DBA %iochan.param Individual I/O channel softlist Default alias: iochan.param Requires TYPE= attributeparameter.fbinst. References a standard or derived function block on the current sheet as a defined-type. (trailing period required) Default alias: fbinst. (period) References the current sheet as a definedtype with the default alias as the sheet instance name Default alias: fbinst If used in a defined-type file, it is treated as a reference to the individual variable indicated by the sheet HMI comment. Default alias: passed defined-type variable ALIAS * (asterisk) References the current sheet as a definedtype with the exception that the default alias is the resource name instead of the current sheet instance name. Default alias: ResourceName 9.15 Variable Attribute Syntax The attribute field of the HMI Comment syntax HMI:source{{:attribute=parameter}...} specifies an attribute of the OS variable. For individual variable comments, an attribute can define the following aspects of the OS variable: Name Comment Engineering high and low values (only for Analog Variables) Engineering units (only for Analog Variables) Discrete State Descriptors (only for Discrete Variables) Maximum String Length (only for String Variables) For defined type comments, an attribute can define the following aspects of the OS variable: Name Structured Type Name The following tables list the attributes supported for various types of variables: Attributes for All Variables Attribute TYPE= TAG or ALIAS= Descriptions Individual variable APACS+ data type or defined-type variable standard or derived function block type or I/O channel type. The name to be used as the HMI database tagname. If not specified, the default ALIAS as described in the Variable Source Syntax section is used A5E

89 Configuring APACS+ for Use with DBA DESC= Variable description or comment (only for Individual Variable HMI Comments) REV= Revision string used to select a specific version from a Defined Type File. A single Defined Type File can define multiple versions of the structure based on this attribute. (only for Structured Variable HMI Comments) Var Property= Any value other than 4 creates an internal tag in the PCS 7 OS. Omitting this attribute or setting the value to 4 creates an external tag. INTERNAL Same as VarProperty= <any value other than 4> EXTERNAL Same as VarProperty=4. Sync= Any non-zero value for this attribute synchronizes the value of the internal tag with the redundant OS server. Sync="RSTA=EventCalculator" This special value synchronize the value of an internal tag used as an alarm acknowledgement tag. Sync="RAW" Special internal tag used as an alarm trigger tag. Persist= Any non-zero value for his attribute ensures that the value of the internal tag persists when the OS server restarts. Persist="RSTA=EventCalculator This special value ensures that the value of an internal tag used as an alarm acknowledgement tag persists when the OS server restarts Persist="RAW" Special internal tag used as an alarm trigger tag. Attributes for Analog Variables Attribute HL or ENGH= LL or ENGL= UNITS= Descriptions Engineering high value (default is variable data type specific) Engineering low value (default is variable data type specific) Engineering units text Attributes for Discrete Variables (TYPE=BOOL) Attribute ON= OFF= Descriptions ON state message text (default = ON if no OFF message) OFF state message text (default = OFF if no ON message) Attributes for String Variables (TYPE=STRING) Attribute LEN= Descriptions Maximum string length value 9.16 Variable Parameter Syntax The parameter choices are as follows: Parameter Description value Use the specified value (must not start with ".") Text or " " Use the specified text ^ or ^text Current sheet instance when used on a sheet. For the ALIAS, DESC, and UNITS attributes in a defined-type file, the carat is replaced with the appropriate parameter value passed down from the associated definedtype Siemens Industrial HMI variable and the optional specified text is Spares added. A5E

90 Configuring APACS+ for Use with DBA >.localvar >.param Get local variable localvar initial value In defined-type file, get the associated standard function block or I/O channel softlist parameter param initial value 9.17 Defined Type File Editor Notice changes made to an.hmi file are not compiled unless the changes are registered by the Loading (Updating) Controller Objects function The Defined Type File Editor creates, edits, and displays ASCII files that define structured OS variable types and associated messages. The advantage to using the Defined Type File Editor instead of an ASCII text edited program is that the Defined Type File Editor parses ASCII text that makes up defined types so that syntax, properties, and values are easily identified and edited. The editor is designed for staff with advanced skills and familiarity with Windowsbased programs. It supports copy-and-paste, for example, but has no menu commands for functions that select, select all, copy, and paste. It is assumed that the person using the program is familiar with the keystrokes that invoke these functions. The editor supports the following Windows file-handling functions: It is assumed that the person using the program is familiar with these commands, too. Opening an Existing File with the Defined Type Editor (General Tab) The Defined Type File Editor can be started by selecting Start > Simatic > DBA > Defined Type Editor. Open an.hmi file by selecting File > Open and moving if necessary to the directory containing the.hmi file of interest, typically C:\Program Files\SIEMENS\DBA\APACS\Templates. Select and open the file. The file opens in the "General" view, where the file is parsed so that its structure is revealed. The left pane of a typical file is shown below (this has been derived from the code provided for the single-loop defined type file in the section titled Defined Type File Layout and Syntax) A5E

91 Configuring APACS+ for Use with DBA The right pane contains two columns, labeled Property and Value corresponding to the object selected in the left pane. If the object #blocktype <variable> were selected in the left pane shown above, the right panel would be as follows: Elements in the Value column can be changed by clicking and editing them. There is no syntax or value checking, just as a plain ASCII editor would not check syntax and value for source code. Edits are reflected in the objects in the left pane. HMI Format Tab Toggling between the General and HMI format tab switches the display between HMI file objects (general) and ASCII text (HMI format). The following illustration shows the example file in ASCII display: ;DEFINEDTYPE:SINGLE_LOOP ;SCHEMAVERSION:1.0.0 [ PCS 7] HMI:TAG_STRUCTURE=SINGLE_LOOP_AFB HMI:"SINGLE_LOOP_AFB":TAG=#blocktype:TYPE=TEXTREF: HMI::TAG=#areaname:TYPE=TEXTREF: HMI:@StripEnclosingApostrophes(VALUE;.DESC.VALUE):TAG=#comment:TYPE =TEXTREF: HMI::TAG=DecimalPlacesPV:TYPE=DWORD:VarProperty=0: HMI::TAG=DecimalPlacesOUT:TYPE=DWORD:VarProperty=0: ; Include common controller information HMI:@INCLUDE(CONTROLLER_COMMON[ PCS 7]) ; Include alarm mapping information HMI:@INCLUDE(ALARM_MAP[ PCS 7]) Siemens Industrial Spares A5E