< PreviousField Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 19 of 79 5 FDI Package implementation 5.1 Packaging technology The FDI Package’s format complies with the Open Packaging Convention as specified by ISO/IEC 29500-2. The Open Packaging Convention specification is designed to represent a broad range of applications. The technology was designed to provide a mechanism for delivering, deploying, and utilizing a set of logically and physically related components in a flexible, extensible, efficient, and open manner. Subclause 5.2 clarifies the use of specific elements of the Open Packaging Conventions specification. Note: fdi-cooperation.com was used when the FDI Cooperation LLC existed. The URL has not been changed to not endanger consistency. The URL does not indicate the current technology ownership and may not point to a valid address. 5.2 Use of Open Packaging Conventions Unknown Parts Unknown parts are all parts not defined in this document or ISO/IEC 29500-2. Unknown parts may exist as the FDI specification is updated and legacy FDI Server may not have knowledge of these additional parts. Unknown parts shall be ignored by the FDI Server to enable forward compatibility. Invalid Parts Invalid parts are those parts that do not conform to the naming guidelines or that do not associate with content types specified in this document or ISO/IEC 29500-2. Invalid parts shall not be used in an FDI Package. Unknown Relationships Unknown relationships are those relationships that are not defined in this document or ISO/IEC 29500-2. Unknown relationships shall be ignored by an FDI Package consumer. Interleaving All parts of the FDI Package shall be laid out using simple ordering. The package producer shall not interleave parts. Core Properties The core properties are not used in the FDI Package Model and shall be ignored by all FDI Package consumers. Thumbnails The thumbnail is an optional part of an FDI Package. Digital Signatures The use of digital signatures as specified in ISO/IEC 29500-2 is a mandatory part of an FDI Package. For more details see Clause 7. 5.3 FDI Package Parts Package Catalog 5.3.1.1 Format The Package Catalog part is an XML file whose schema is defined in Annex E. An FDI Package shall have only one Package Catalog. The Package Catalog shall be identified by a single package relationship. The root element of the file is Catalog. The structure of a Catalog element is illustrated in Figure 11. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 20 of 79 Catalog PackageId PackageType Version FdiVersionSupported ManufacturerName ManufacturerContact ManufacturerUrl ManufacturerImage ListOfDeviceTypes Figure 11 – Catalog Element The Package Catalog part is described in Table 2. Table 2 – Package Catalog Part Part Content Content Type application/vnd.fdi.package.catalog+xml Root Namespace http://fdi-cooperation.com/2010/package-catalog Source Relationship http://fdi-cooperation.com/2010/relationships/package-catalog Filename catalog.xml 5.3.1.2 Content The schema for the Package Catalog is described in Annex E. Electronic Device Description 5.3.2.1 Format The EDD is an encoded file using the Electronic Device Description Language (EDDL) according to 5.3.2.2. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 21 of 79 The format of the EDD part is described in Table 3. Table 3 – EDD part Part Content Content Type application/vnd.fdi.package.edd Root Namespace Not applicable Source Relationship http://fdi-cooperation.com/2010/relationships/edd Filename Not specified 5.3.2.2 Content The EDDL is specified in FCG TS61804. User Interface Plug-in 5.3.3.1 Format An FDI Package may contain one or more User Interface Plug-in parts. All User Interface Plug-in parts shall be identified by a package relationship. The User Interface Plug-In represents a container element for UIP Variants (see 5.3.3.2.2.2), which contain the physical representation of a UIP (different variants for different platforms) that is consumed and executed by an FDI Client. A User Interface Plug-in shall at least provide one UIP Variant. The variants are packaged into a single User Interface Plug-in using Open Packaging Convention as specified in 5.3.3.2. The User Interface Plug-in is not directly consumed by an FDI Server. The User Interface Plug-in is an optional part of different FDI Package types as specified in 4.3. The User Interface Plug-in is illustrated in Figure 12. The UIP version information as well as the update and upgrade behavior shall follow the rules and concepts described in FCG TS61804-1. The default locale for UIPs and all contained variants is English/(US).Optional language support is allowed according to market needs. User Interface Plug-in UIP Catalog User Interface Plug-in User Interface Plug-in Variant Mandatory Element Figure 12 – User Interface Plug-in The format for the User Interface Plug-in part is described in Table 4. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 22 of 79 Table 4 – User Interface Plug-in part Part Content Content Type application/vnd.fdi.package.uip Root Namespace Not applicable Source Relationship http://fdi-cooperation.com/2010/relationships/uip Filename extension shall be .uip 5.3.3.2 Content 5.3.3.2.1 Use of Open Packaging Convention 5.3.3.2.1.1 Core Core Properties are not used and shall be ignored by all FDI UIP Package consumers. 5.3.3.2.1.2 Thumbnails Thumbnails are not used and shall be ignored by all FDI UIP Package consumers. 5.3.3.2.1.3 Digital Signatures Digital signatures might be necessary for UIP Variants (see 5.3.3.2.2.2) depending on the implementation technology. Implementation technology details and necessary mechanisms to be implemented are described in FCG TS62769-6. The User Interface Plug-in as such however shall not be signed or applied signatures shall be ignored by the consuming FDI component. 5.3.3.2.2 User Interface Plug-in Parts 5.3.3.2.2.1 UIP Catalog 5.3.3.2.2.1.1 Format The UIP Catalog is an XML file describing the properties of a UIP that are necessary to create the Information Model nodes in the FDI Server side and for deployment (FDI Server to FDI Client). The UIP Catalog also hosts information about the physical starting element that has to be called/executed from a UIP Variant on the FDI Client. The format and type of this starting element are technology specific and therefore defined in FCG TS62769-6. The UIP Catalog shall be identified by a single package relationship. The UIP Catalog part is an XML file whose schema is defined in Annex E. A User Interface Plug-in shall have only one UIP Catalog. The root element of the file is UipCatalog. The structure of the UipCatalog element is illustrated in Figure 13. Figure 13 – UIP Catalog The UIP Catalog part is described in Table 5. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 23 of 79 Table 5 – UIP Catalog Part Part Content Content Type application/vnd.fdi.package.uip.catalog+xml Root Namespace http://fdi-cooperation.com/2010/uip-catalog Source Relationship http://fdi-cooperation.com/2010/relationships/uip-catalog Filename uipcatalog.xml 5.3.3.2.2.1.2 Content The schema for the UIP Catalog is described in Annex E. 5.3.3.2.2.2 UIP Variant 5.3.3.2.2.2.1 Format A UIP Variant can be provided to support different versions of the base technology. It is a container for all physical files that represent the UIP Variant, independently of their type and number. The UIP Variant shall use the ZIP file format (compressed archive, application/zip media type) as bundling technology. Use of the ZIP specification for bundling variants shall be constrained to the requirements in ISO/IEC 29500-2:2011, Annex C. The UIP Variant part is described in Table 6. Table 6 – UIP Variant Part Part Content Content Type application/zip Root Namespace Not applicable Source Relationship http://fdi-cooperation.com/2010/relationships/uip-variant Filename Not specified 5.3.3.2.2.2.2 Content The content of the UIP Variant is specified in FCG TS62769-6. Attachments 5.3.4.1 Image An FDI Package image attachment is a computer icon that represents the device type. Multiple images and resolutions of the device type are supported. Each image shall be PNG format and restricted to the following pixel resolutions: 256 × 256, 64 × 64, 32 × 32 or 16 × 16. The image part is described in Table 7. If the Device Package is supposed to support handheld devices the provided image shall be available in a resolution of 16 pixels × 16 pixels. Table 7 – Image Part Part Content Content Type image/png Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 24 of 79 Root Namespace Not applicable Source Relationship http://fdi-cooperation.com/2010/relationships/attachment-image Filename Not specified 5.3.4.2 Documentation Documentation parts include documentation such as product manuals and data sheets and shall be encoded in PDF or plain text format. The documentation Attachment is described in Table 8. Table 8 – Documentation Part Part Content Content Type Application/pdf (specified in 32000-1) Text/plain Root Namespace Not applicable Source Relationship http://fdi-cooperation.com/2010/relationships/attachment-documentation Filename Not specified 5.3.4.3 Protocol Support File The protocol support file part is a file not defined by this standard but necessary to integrate the product into a system. Those files usually extend the integration mechanism provided in the basic part of the FDI Device Package (EDD, UIPs) by protocol specific means. Those files shall be neither executables nor binary files of any kind. In addition, those files shall not replace any mandatory elements of an FDI Device Package. A list of protocol support files for the different communication protocols are defined in Annex F. The protocol specific support file part is described in Table 9. Table 9 – Protocol Support File Part Part Content Content Type Not specified here Root Namespace Not specified here Source Relationship http://fdi-cooperation.com/2010/relationships/attachment-protocol Filename Not specified here 5.3.4.4 FDI Registration Certificate 5.3.4.4.1 Format The FDI Registration certificate is a single XML document per FDI Package which can be present (optional FDI Package Element). In the scope of an FDI Package it is a Package Element of the type Attachment. Table 10 – FDI Registration Certificate Part Part Content Content Type application/vnd.fdi.package.registrationCert+xml Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 25 of 79 Root Namespace Not specified here Source Relationship http://fdi-cooperation.com/2010/relationships/attachment-registrationCert Filename RegistrationCert.xml 5.3.4.4.2 Content The FDI Registration Certificate is machine readable and is represented in XML Format and has the content and structure according to Figure 14. The FDI Registration Certificate may be signed with a detached signature within the same document. FdiRegistrationCert PackageId Version ListOfRegDeviceTypes RegDeviceType Manufacturer DeviceModel ListOfRegistrations Registration RegistrationDate RegAuthorityIdent RegistrationData Figure 14 – FDI Registration Certificate The schema for the FDI Registration Certificate is described in Annex E. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 26 of 79 6 FDI Package Versioning 6.1 Version Scheme FDI elements use a major.minor.revision numeric versioning scheme for package and package elements. The initial version shall be 01.00.00. Incompatible changes are indicated by incrementing the major number. Functional changes that still maintain compatibility to the major version are indicated by incrementing the minor number. Non-functional changes, such as editorial changes are indicated by incrementing the revision number. Rules for incrementing the version number are described in 6.3. 6.2 Versioned Elements An FDI Package contains the version information that is described in Table 11. Table 11 – Versioned Elements Scope Version Location Schema Reference FDI Package (see 5.3) Package Catalog (see 5.3.1) See Annex E, Version element of the Package complex type UIP (see 5.3.3) UIP Catalog (see 5.3.3.2.2.1) See Annex E, Version element of the Uip complex type UIP Variant (See 5.3.3.2.2.2) UIP Catalog (see 5.3.3.2.2.1) See Annex E, Version element of the UipVariant complex type The following parts of the FDI Package have version mechanisms that are outside the scope of the FDI. • EDD (see 5.3.2) – DD_REVISION and DEVICE_REVISION according to FCG TS61804-3 • Attachments (see 5.3.4) – Image (see 5.3.4.1) – Documentation (see 5.3.4.2) – Protocol Support File (see 5.3.4.3 and Annex F) 6.3 Version Hierarchy The version change of FDI Package elements can influence the version of overlaying elements. Figure 15 illustrates those influences. The orange boxes show elements that are versioned using the FDI specific version mechanisms described in FCG TS62769-1. The green boxes indicate elements that have version mechanisms that are not described by FDI. The white boxes describe elements that are not explicitly versioned. All elements in the tree structure shown below influence the version of the parent elements according to Table 12. Their version change causes a version change of the overlaying element. Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 27 of 79 FDI Package FDI Package Catalog UIP EDDAttachment Protocol Support File Image Documentation UIP Variant UIP Variant Content Key: FDI versioning Non FDI versioning Non specific versioning Version influence Version support Figure 15 – Version Hierarchy Table 12 describes a selection of possible changes to the different FDI Package elements and their direct influence on the FDI Package version. At a minimum, successive FDI Package versions shall increment the revision number. Table 12 – Influence on FDI Package Version Element Version Level FDI Package Type Major Minor Revision Device/ Profile/ Comm Package UIP Package Package Catalog n/a Modifying existing compatibility references. Change to ListOfSupportedUips (see Annex E). Only addition of wildcards is allowed for modifications to existing VersionSupported (see Annex E) Editorial x x EDD Increment Device Revision Increment DD_REVISION with same DEVICE_REVISION n/a x Attachments Changes to Protocol Support Files Changes to Protocol Support Files Changes to Documentation, Images, Protocol Support Files x UIP Incompatible changes Technology driven Functional enhancement Technology driven Bug fix Technology driven x x Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 28 of 79 Annex G describes typical FDI Package life-cycle use cases for a better understanding of the version hierarchy and the versioning concept. 6.4 UIP Compatibility UIPs are delivered in an FDI Device Package, FDI Communication Package, FDI Profile Package or an FDI UIP Package. A UIP delivered in an FDI UIP Package shall not be delivered in any other package type. Therefore, an FDI Package may not be self-contained. FDI Device Packages, FDI Communication Packages and FDI Profile Packages do not directly reference UIPs. Instead, the Package Catalog defines the SupportedUip (see Annex E) to define compatible UIPs. More than one installed UIP may be compatible with a given FDI Package version. This permits the FDI Package creators to provide bug fixes and functional enhancements to the FDI Package without the need to provide a major release of an FDI Package. The version support described in the Package Catalog is defined as follows: • The major release number shall be specified explicitly as a single, two digit number. • The minor release number and revision number shall be specified explicitly as a single number or as a wildcard (‘*’). If the minor release number is specified as a wildcard, then the revision number shall also be specified as a wildcard. NOTE Examples of valid compatible version numbers are 01.03.01, 01.03.*, 01.*.*. The use of a wildcard indicates that all minor numbers and/or revision numbers are compatible with the FDI Package. If the SupportedUip has been defined by using wildcards and there is more than one version of the UIP available, the FDI Server shall transfer the latest version to the FDI Client. System specific implementations that allow coexistence of minor release or revisions releases regardless of version support wildcards are outside the scope of this standard. Next >