< PreviousField Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 9 of 79 1 Scope This part of FCG TS62769 specifies the FDI Packages. The overall FDI architecture is illustrated in Figure 1. The architectural components that are within the scope of this document have been highlighted in this figure. FDI Server Information Model Management OPC UA FDI Package Device Definition Business Logic User Interface User Interface Plug-in Information Model FDI Client Device Access Services User Interface Services Platform UI Services (Drawing, Input Devices) Hosting Services User Interface Plug-in FDI Package Device Definition Business Logic User Interface Description Business Logic Processor OPC UA Services Device Object Device Object Device Object User Interface Plug-in UID Interpreter Business Logic Interface Business Logic User Interface Description Communication Server UID Data Store System Services System Communication Hardware OPC UA Client OPC UA OPC UA Services OPC UA Services UIP Services Specified by this part of this International Standard Specified by other parts of this International Standard Not specified by this International Standard Figure 1 – FDI architecture diagram 2 Normative references The following documents, in whole or in part, are normatively referenced in this document and are indispensable for its application. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies. FCG TS61804 (all parts), Function blocks (FB) for process control and Electronic Device Description Language (EDDL) FCG TS61804-3, Function blocks (FB) for process control and Electronic Device Description Language (EDDL) – Part 3: EDDL syntax and semantics FCG TS61804-4, Function blocks (FB) for process control and Electronic device description language (EDDL) – Part 4: EDD interpretation FCG TS62769-1, Field Device Integration (FDI) – Part 1: Overview Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 10 of 79 FCG TS62769-5, Field Device Integration (FDI) – Part 5: FDI Information Model FCG TS62769-6, Field Device Integration (FDI) – Part 6: FDI Technology Mapping FCG TS62769-7, Field Device Integration (FDI) – Part 7: FDI Communication Devices ISO/IEC 11578, Information technology – Open Systems Interconnection – Remote Procedure Call (RPC) ISO/IEC 29500-2:2011, Information technology – Document description and processing languages – Office Open XML File Formats – Part 2: Open Packaging Conventions ISO 639-1, Codes for the representation of names of languages – Part 1: Alpha-2 code ISO 32000-1, Document management – Portable document format – Part 1: PDF 1.7 Extensible Markup Language (XML) 1.0, W3C Recommendation, available at <http://www.w3.org/TR/REC-xml/> XML Schema Definition Language (XSD) 1.1, W3C Recommendation, available at <http://www.w3.org/TR/xmlschema11-1/> 3 Terms, definitions, abbreviated terms and acronyms 3.1 Terms and definitions For the purposes of this document, the terms and definitions given in FCG TS62769-1, ISO/IEC 29500-2, and the following apply. attachment device and protocol specific support files that are not directly used to integrate the Device into the system FDI Communication Package FDI Package that provides information to integrate an FDI Communication Server to an FDI Server Note 1 to entry: This note applies to the French language only. FDI Device Package FDI Package that provides one or more device types to an FDI Server Note 1 to entry: This note applies to the French language only. FDI Package Model description of the structure and elements of an FDI Package Note 1 to entry: This note applies to the French language only. FDI Profile Package FDI Package that provides information for creating a device type node that can be associated with a class of devices Note 1 to entry: This note applies to the French language only. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 11 of 79 FDI Registration Authority entity, which has the right and the ability to perform FDI conformance tests on FDI Packages and to issue registration certificate documents FDI UIP Package FDI Package that provides one or more UIPs to an FDI Server Note 1 to entry: This note applies to the French language only. Note 2 to entry: This note applies to the French language only. Package Catalog file that describes the contents of an FDI Package Note 1 to entry: This note applies to the French language only. UIP Catalog file that describes the properties of a UIP Note 1 to entry: This note applies to the French language only. UIP Variant platform specific element of a User Interface Plug-in Note 1 to entry: A UIP is composed of one or more variants. For example, one variant may be optimized for portable devices while another variant is optimized for large screen devices. Note to entry: This note applies to the French language only. 3.2 Abbreviated terms and acronyms For the purposes of this document, the abbreviated terms and acronyms given in FCG TS62769-1 as well as the following apply. CFF Capabilities File for FOUNDATION Fieldbus ID Identifier IDE Integrated Development Environment IM Information Model PNG Portable network graphics ZIP Zipper (archive file format) Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 12 of 79 4 FDI Package Model 4.1 Overview The FDI Package Model (see Figure 2) provides all of the elements necessary to integrate devices, network components and FDI Communication Servers into a system. FDI Package Package Catalog EDD User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in Attachments Figure 2 – FDI Package Model Figure 3 shows the mapping of the FDI Package functional elements, as specified in FCG TS62769-1, to the physical elements in an actual FDI Package, as specified in this standard. FDI Package Device Definition Business Logic User Interface Description User Interface Plug-in FDI Package Package Catalog EDD User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in Attachments Figure 3 – Architectural mapping The Electronic Device Description (EDD) corresponds to the Device Definition, the User Interface Description, and the Business Logic functional elements. A set of physical User Interface Plug-ins corresponds to the User Interface Plug-in functional element. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 13 of 79 The other physical elements in the FDI Package, the Package Catalog and Attachments, provide support for basic mechanisms such as identification, versioning and deployment, and distribution of manufacturer and/or protocol specific information about the device and/or the User Interface Plug-ins. 4.2 FDI Package Elements Package Catalog The Package Catalog is a required element that provides information about the contents of the FDI Package including, but not limited to, identification and version information, device type information, hardware and input/output device requirements, FDI Technology Version, and protocol specific characteristics. The Package Catalog is used by an FDI Server to create a catalog of device types and to create DeviceType Nodes in the Information Model. Electronic Device Description The EDD is an element that provides Device Definition, User Interface Descriptions, and Business Logic to an FDI Server. Subclause 4.3 specifies for which FDI Package types an EDD is required. To maximize interoperability, the initial setup of a device shall be achievable solely with the User Interface Descriptions, Device Definition and Business Logic that are part of the EDD in the FDI Device Package. The use of User Interface Plug-ins is optional and targeted in particular for the complete setup of complex devices. User Interface Plug-in A User Interface Plug-in (UIP) is an element that enables an FDI Client to present a programmed user interface. The FDI Server only stores the UIP from a consumed package; it does not execute or interpret the UIP. A UIP is referenced from a User Interface Description. Those references are reflected in the Information Model through functional groups (see FCG TS62769-5). References to UIPs in the Information Model are logical through a unique reference. The physical structure of the UIP is not at the Information Model level. Physically, a single UIP may consist of one or more UIP Variants, each targeted at a specific platform and run-time environment. Figure 4 illustrates the logical reference to a UIP in the EDD and the physical structure of that UIP. The EDD of the FDI Package references a globally unique identifier of the UIP. In addition, the Package Catalog also lists the UIPs required by the device type along with the versions of the UIP supported by the package. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 14 of 79 Logical UIP Reference UIP A – Version 1.1.2 EDDUIP A Variant 1 RunTime X Workstation Variant 2 RunTime X Mobile Package Catalog UIP A Suported Version 1.1.* UIP Catalog Variant 3 RunTime Y Workstation Figure 4 – User Interface Plug-in Reference Model A UIP can be designed to meet different platform requirements since not all platforms support the same screen sizes and input devices. When an FDI Client requests a UIP specifying the platform type, the deployment mechanism in the FDI Server looks for a UIP Variant that meets the platform type specified and returns it to the FDI Client. The target platform defines specific screen resolutions and input devices that shall be supported by the UIP Variant. Available target platforms are described in Table 1. Table 1 – UIP Platform Capabilities Platform Characteristics Workstation A client for the Workstation platform is characterized by the following minimum set of supported I/O devices: mouse, keyboard, and color screen resolution of 1024 x 768 pixels. Mobile A client for the Mobile platform shall feature at minimum a full-graphic screen with a resolution of 480 x 640 pixels. It shall support some way for the input of numbers, characters and ASCII symbols (e.g. a touch screen with an emulated keyboard) as well as some means to scroll, to zoom, to select and to click (single or double click) on text or other elements displayed on the screen. WorkstationAndMobile The UIP has the capability to run on the Workstation platform and the Mobile platform. Technology dependent platform requirements are specified in FCG TS62769-6. A UIP can be delivered internally (self-contained) or the UIP can be delivered through an FDI UIP Package. An EDD of one package shall not reference any UIP delivered self-contained with another package. Figure 5 illustrates two FDI Device Packages referencing UIPs from an FDI UIP Package. In this example, the EDD from Device Package A and Device Package B references UIP B delivered by UIP Package C. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 15 of 79 Device Package A Package Catalog EDD User Interface Plug-in User Interface Plug-in Attachments Device Package B Package Catalog EDD User Interface Plug-in User Interface Plug-in Attachments UIP Package C Package Catalog UIP BUIP A Figure 5 – Multiple FDI Packages referencing a common UIP Attachment Attachments provide device and protocol specific support files, along with other files that are not directly used to integrate the device into the system, for example, product manuals. The following types of Attachments are defined and reflected in the Package Catalog: • Protocol specific files (see 5.3.4.3). • Documentation (see 5.3.4.2). • Device pictures (see 5.3.4.1). Some protocol specific files are mandatory (see Annex F). 4.3 FDI Package Types FDI Device Package The FDI Device Package is intended to provide information about a device to a system. An FDI Device Package describes a single device type. Figure 6 shows the physical structure of an FDI Device Package describing a single device type. Details about how to create a package for a modular device is described in Annex I. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 16 of 79 FDI Device Package CatalogEDD User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in Attachments Mandatory Element Figure 6 – FDI Device Package The FDI Device Package shall have a single Package Catalog. An FDI Package for simple Devices contains one EDD. For modular Devices multiple EDDs may exist (see Annex I). The FDI Device Package may include one or more User Interface Plug-ins. The FDI Device Package may include Attachments. FDI Communication Package The FDI Communication Package is intended to provide information about a single FDI Communication Device. The group of FDI Communication Devices splits into two sub-groups. - FDI Communication Packages for Gateways – Contain everything required to describe all device functions and logic required to bridge between different communication protocol networks, including the bridging algorithms (details are described in FCG TS62769-7). - FDI Communication Packages for FDI Communication Servers – Contain basic information to describe the communication device and to integrate it into the FDI Host but also to create a valid reference to the external FDI Communication Server application. This application shall not be delivered as part of the FDI Communication Package. The FDI Communication Server provides access to single field devices or field device networks (details are described in FCG TS62769-7). Requirements to the FDI Communication Package content that are specific for FDI Communication Servers are defined in Annex J. However, representatives of both groups are integrated into FDI Hosts by using FDI Communication Packages. Their physical structure is shown in Figure 7. Binary components necessary to communicate to the communication hardware shall be provided outside the scope of this FDI Communication Package. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 17 of 79 FDI Communication Package Package Catalog EDD User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in Attachments Mandatory Element Figure 7 – FDI Communication Package FDI UIP Package The FDI UIP Package delivers User Interface Plug-ins to an FDI Server. It is used to distribute one or more UIPs that are intended to be shared by several device types. Its physical structure is illustrated in Figure 8. User Interface Plug-in Package Package Catalog User Interface Plug-in User Interface Plug-in User Interface Plug-in Mandatory Element Figure 8 – FDI UIP Package The FDI UIP Package shall have a Package Catalog and one or more User Interface Plug-ins. FDI Profile Package An FDI Profile Package provides information for creating a device type node that can be associated with a class of devices implementing a common set of parameters and functions (described in profiles or profile like definitions created by, for example, communication foundations or similar interest groups). Conceptually, an FDI Profile Package provides information that is a super class of an FDI Device Package. The FDI Profile Package is represented in Figure 9. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 18 of 79 FDI Profile Package Package Catalog EDD User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in User Interface Plug-in Attachments Mandatory Element Figure 9 – FDI Profile Package These packages enable integration of devices without having a specific FDI Device Package. FDI Profile Packages only support standard functionalities as defined by the corresponding communication protocol and application profiles (Annex F). An FDI Profile Package shall be self-contained. For example, if a Profile B extends the definition of a Profile A, then the FDI Profile Package for the Profile B shall include a complete definition of Profile B, including the elements from Profile A. Figure 10 – Device Function and Parameter sets (type and profile specific) Figure 10 represents the entire functionality of a device. Some of the functionality conforms to a specific communication profile, which may be accessed by using an FDI Profile Package. If there is a need to access Device Type specific functionality, in addition to the common functionality, then an FDI Device Package is required. An automatic FDI Package selection implementation (launching FDI Packages matching a connected physical device) typically would search first for available Device Type specific FDI Device Packages. If the specific package is not available the profile specific FDI Profile Package is loaded (if available). This behavior however is system specific. Profile specific common subset Device Type specific FDI Device Package Profile specific FDI Profile Package Device Function & Parameter set Type specific subset Next >