Field Device Integration (FDI) – Part 2: Client FCG TS62769-2 Edition 1.2.0 27 Jun 2019 RELEASED S P E C I F I C A T I O N Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 1 of 145 Document Distribution / Maintenance Control / Document Approval To obtain information concerning document distribution control, maintenance control, and document approval please contact FieldComm Group at the address shown below. Copyright © 2019 (2014, 2017) FieldComm Group, PROFIBUS Nutzerorganisation e. V., OPC Foundation, FDT Group FieldComm Group, PROFIBUS Nutzerorganisation e.V, OPC Foundation, and FDT Group are the joint publishers of this document. The information in this document is subject to change without notice and should not be construed as a commitment by the publishers. The publishers assume no responsibility for any errors that may appear in this document. In no event shall the publishers be liable for direct, indirect, special, incidental or consequential damages of any nature or kind arising from the use of this document. This document and parts thereof must not be reproduced or copied without written permission from the publishers, and the contents thereof must not be imparted to a third party nor used for any unauthorized purpose. All rights to copyrights, registered trademarks or applications, utility models and registered patents or applications reside with their respective owners. Trademark Information FieldComm Group ™ , F OUNDATION ™ Fieldbus and HART-IP ™ are trademarks, and HART ® , WirelessHART ® , ROM ® and SIF ® are registered trademarks of FieldComm Group, Austin, Texas, USA Any use of these terms hereafter in this document, or in any document referenced by this document, implies the trademark/registered trademark. All other trademarks used in this or referenced documents are trademarks of their respective companies. For more information, contact: FDT Group 5 Industrieweg 3001 Heverlee Belgium Phone: +32 (0)10 22 22 51 fdtgroup.org FieldComm Group 9430 Research Boulevard Suite 1-120 Austin, TX 78759, USA Phone: (512) 792-2300 Fax: (512) 792-2310 fieldcommgroup.org OPC Foundation Presidential Office 8455 Infirmary Rd., Ravenna, OH 44266 P.O. Box 808 (mailing address) Mantua, Ohio 44255 Phone: (330) 839-8718 opcfoundation.org PROFIBUS Nutzerorganisation e. V. (PNO) PROFIBUS & PROFINET International (PI) Haid-und-Neu-Str. 7 76131 Karlsruhe Germany Phone: +49 721 96 58 590 Fax: +49 721 96 58 589 profibus.com profinet.com Intellectual Property Rights The FieldComm Group (the Group) does not knowingly use or incorporate any information or data into the HART, F OUNDATION Fieldbus and FDI protocol standards, which the Group does not own or have lawful rights to use. Should the Group receive any notification regarding the existence of any conflicting private IPR, the Group will review the disclosure and either (A) determine there is no conflict; (B) resolve the conflict with the IPR owner; or (C) modify the standard to remove the conflicting requirement. In no case does the Group encourage implementers to infringe on any individual's or organization's IPR. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 2 of 145 Revision Log Version Date Change Note / History / Reason 1.0.0.0 01 Nov 2014 First Release 1.1.0.0 12 April 2016 New document template, issues 1831, 1832, and 1839 solved Updates UIP permissions to match Part 6 (issue 5841) Removed setting of display information from Activate Service. 1.1.0.1 05 June 2016 Sections 6.4.1 to 6.4.6 added (issue 1860) 1.1.0.2 13 June 2016 Sections 5.2.2.16 to 5.2.2.21 and 6.5.2 added (issue 1860) 1.1.0.3 04 July 2016 Add Sections 5.2.2.16, 5.2.2.17, 5.2.2.18, 5.2.2.19, 5.2.2.20, 5.2.2.21, 5.2.2.22, 5.2.2.23, 5.2.2.24, and 5.2.2.25 to handle files when UIP runs in a process with limited user access rights. 1.1.0.4 06 July 2016 Removed Section 5.2.2.2.3 (Service results) to be consistent with other hosting services. Added note to 5.2.2.3.1. 1.1.0.5 19 Dec 2016 New document template 1.1.0.6 24 Feb 2017 New cover page and trademark information 1.1.0.7 26 July 2017 Deleted OpenModalUserInterface from Table 75; added parameter class attribute “CONSTANT” in A.59; added ActionClassT “BACKGROUND” in A.60 (Bugzilla 2366); clarification in section 5.1.8.1 (Bugzilla 2041) 1.2.0.5 17 Oct. 2018 Added key/value pairs for service Added ListOfActionArgumentsT to Annex A Editorial Changes 1.2.0.6 22 Feb. 2019 Moved specification of StatusCodes to FCG TS62769-5, integrated remaining parts of sections 5.1.4.5 and 5.1.4.6 into 5.1.4.4 (Bugzilla 1693, 2206, 2415, 2417) 1.2.0.7 23 April 2019 Added return service results and return parameter for service OpenUserInterface (Bugzilla 2801) 1.2.0.8 21 June 2019 Clarification of reference to technology mappings (FCG TS62769-6), update of AttributeIds, editorial changes (Balloting comments 895, 930, 932, 934, 935) Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 3 of 145 TABLE OF CONTENTS 1 Scope ..........................................................................................................................................................17 2 Normative references .................................................................................................................................18 3 Terms, definitions, abbreviated terms, acronyms and conventions ..............................................................19 3.1 Terms and definitions ...................................................................................................................19 Terms used for Services .............................................................................................19 Terms used for Device Access Services.......................................................................19 3.2 Abbreviated terms and acronyms .................................................................................................20 3.3 Conventions .................................................................................................................................20 4 Overview ....................................................................................................................................................20 5 FDI Client ....................................................................................................................................................21 5.1 Device Access Services .................................................................................................................21 General .....................................................................................................................21 Device Model ............................................................................................................22 Node model ...............................................................................................................23 5.1.3.1 General .................................................................................................................23 5.1.3.2 BaseNodeClass ......................................................................................................23 5.1.3.3 Object NodeClass...................................................................................................24 5.1.3.4 Variable NodeClass ................................................................................................24 5.1.3.4.1 General ...............................................................................................24 5.1.3.4.2 Representation of images ...................................................................26 5.1.3.4.3 Representation of records...................................................................26 5.1.3.4.4 Representation of arrays, and lists of members with simple data types ..................................................................................................27 5.1.3.4.5 Representation of arrays, and lists of RECORDs ...................................28 Services .....................................................................................................................28 5.1.4.1 General .................................................................................................................28 5.1.4.2 Conventions for service definitions ........................................................................29 5.1.4.3 Auditing.................................................................................................................29 5.1.4.4 Result codes for services and operations ...............................................................30 Base Property Services ..............................................................................................31 5.1.5.1 Overview ...............................................................................................................31 5.1.5.2 Get DeviceAccess interface version ........................................................................31 5.1.5.2.1 Description .........................................................................................31 5.1.5.2.2 Parameters .........................................................................................31 5.1.5.2.3 Service results ....................................................................................31 5.1.5.3 GetOnlineAccessAvailability ...................................................................................31 5.1.5.3.1 Description .........................................................................................31 5.1.5.3.2 Parameters .........................................................................................31 5.1.5.3.3 Service results ....................................................................................31 Device Model Services ...............................................................................................31 Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 4 of 145 5.1.6.1 Overview ...............................................................................................................31 5.1.6.2 Browse ..................................................................................................................32 5.1.6.2.1 Description .........................................................................................32 5.1.6.2.2 Parameters .........................................................................................32 5.1.6.2.3 Service results ....................................................................................32 5.1.6.3 CancelBrowse ........................................................................................................32 5.1.6.3.1 Description .........................................................................................32 5.1.6.3.2 Parameters .........................................................................................33 5.1.6.3.3 Service results ....................................................................................33 5.1.6.4 Read ......................................................................................................................33 5.1.6.4.1 Description .........................................................................................33 5.1.6.4.2 Parameters .........................................................................................33 5.1.6.4.3 Service results ....................................................................................34 5.1.6.4.4 Operation result codes........................................................................34 5.1.6.5 CancelRead ............................................................................................................35 5.1.6.5.1 Description .........................................................................................35 5.1.6.5.2 Parameters .........................................................................................35 5.1.6.5.3 Service results ....................................................................................35 5.1.6.6 Write .....................................................................................................................35 5.1.6.6.1 Description .........................................................................................35 5.1.6.6.2 Parameters .........................................................................................35 5.1.6.6.3 Service results ....................................................................................36 5.1.6.6.4 Operation result codes........................................................................36 5.1.6.7 CancelWrite ...........................................................................................................36 5.1.6.7.1 Description .........................................................................................36 5.1.6.7.2 Parameters .........................................................................................36 5.1.6.7.3 Service results ....................................................................................37 5.1.6.8 Subscriptions .........................................................................................................37 5.1.6.8.1 Subscription mechanism .....................................................................37 5.1.6.8.2 CreateSubscription Service .................................................................37 5.1.6.8.3 Subscribe Service ................................................................................38 5.1.6.8.4 Unsubscribe Service ............................................................................40 5.1.6.8.5 DeleteSubscription Service..................................................................41 5.1.6.8.6 DataChangeCallback Service................................................................41 Locking Services ........................................................................................................42 5.1.7.1 Overview ...............................................................................................................42 5.1.7.2 InitLock service ......................................................................................................42 5.1.7.2.1 Description .........................................................................................42 5.1.7.2.2 Parameters .........................................................................................43 5.1.7.2.3 Service results ....................................................................................43 5.1.7.3 ExitLock service .....................................................................................................43 5.1.7.3.1 Description .........................................................................................43 Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 5 of 145 5.1.7.3.2 Parameters .........................................................................................43 5.1.7.3.3 Service results ....................................................................................43 Direct Access Services ...............................................................................................44 5.1.8.1 Overview ...............................................................................................................44 5.1.8.2 InitDirectAccess .....................................................................................................44 5.1.8.2.1 Description .........................................................................................44 5.1.8.2.2 Parameters .........................................................................................44 5.1.8.2.3 Service results ....................................................................................45 5.1.8.3 ExitDirectAccess ....................................................................................................45 5.1.8.3.1 Description .........................................................................................45 5.1.8.3.2 Parameters .........................................................................................45 5.1.8.3.3 Service results ....................................................................................45 5.1.8.4 Transfer .................................................................................................................45 5.1.8.4.1 Description .........................................................................................45 5.1.8.4.2 Parameters .........................................................................................46 5.1.8.4.3 Service results ....................................................................................46 Data types .................................................................................................................46 5.1.9.1 General .................................................................................................................46 5.1.9.2 Base data types .....................................................................................................46 5.1.9.3 Special types .........................................................................................................47 5.1.9.3.1 AttributeIds ........................................................................................47 5.1.9.3.2 NodeSpecifier .....................................................................................47 5.1.9.3.3 DataValue ...........................................................................................48 5.1.9.3.4 InnerErrorInfo .....................................................................................49 5.1.9.3.5 LocalizedText ......................................................................................49 5.1.9.3.6 Numeric Range ...................................................................................50 5.1.9.3.7 Range .................................................................................................50 5.1.9.3.8 EUInformation ....................................................................................50 5.1.9.3.9 EnumValueType ..................................................................................51 5.1.9.4 Variant ..................................................................................................................51 5.2 Hosting Services ...........................................................................................................................51 General .....................................................................................................................51 Services .....................................................................................................................51 5.2.2.1 General .................................................................................................................51 5.2.2.2 GetClientTechnology Version .................................................................................51 5.2.2.2.1 Description .........................................................................................51 5.2.2.2.2 Parameters .........................................................................................51 5.2.2.3 OpenUserInterface Service ....................................................................................52 5.2.2.3.1 Description .........................................................................................52 5.2.2.3.2 Parameters .........................................................................................52 5.2.2.3.3 Service results ....................................................................................52 5.2.2.4 CloseUserInterface Service ....................................................................................52 Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 6 of 145 5.2.2.4.1 Description .........................................................................................52 5.2.2.4.2 Parameters .........................................................................................52 5.2.2.4.3 Service results ....................................................................................53 5.2.2.5 LogAuditTrailMessage Service ................................................................................53 5.2.2.5.1 Description .........................................................................................53 5.2.2.5.2 Parameters .........................................................................................53 5.2.2.6 SaveUserSettings Service .......................................................................................53 5.2.2.6.1 Description .........................................................................................53 5.2.2.6.2 Parameters .........................................................................................53 5.2.2.7 LoadUserSettings Service .......................................................................................54 5.2.2.7.1 Description .........................................................................................54 5.2.2.7.2 Parameters .........................................................................................54 5.2.2.8 Trace Service .........................................................................................................54 5.2.2.8.1 Description .........................................................................................54 5.2.2.8.2 Parameters .........................................................................................54 5.2.2.9 ShowMessageBox Service ......................................................................................54 5.2.2.9.1 Description .........................................................................................54 5.2.2.9.2 Parameters .........................................................................................55 5.2.2.10 ShowProgressBar Service .......................................................................................55 5.2.2.10.1 Description .........................................................................................55 5.2.2.10.2 Parameters .........................................................................................55 5.2.2.11 UpdateShowProgressBar Service............................................................................55 5.2.2.11.1 Description .........................................................................................55 5.2.2.11.2 Parameters .........................................................................................55 5.2.2.12 EndShowProgressBar Service .................................................................................56 5.2.2.12.1 Description .........................................................................................56 5.2.2.12.2 Parameters .........................................................................................56 5.2.2.13 CancelCallback Service ...........................................................................................56 5.2.2.13.1 Description .........................................................................................56 5.2.2.13.2 Parameters .........................................................................................56 5.2.2.14 StandardUIActionItemsChangeCallback Service ......................................................56 5.2.2.14.1 Description .........................................................................................56 5.2.2.14.2 Parameters .........................................................................................56 5.2.2.15 SpecificUIActionItemsChangeCallback Service ........................................................57 5.2.2.15.1 Description .........................................................................................57 5.2.2.15.2 Parameters .........................................................................................57 5.2.2.16 InitExportFile Service .............................................................................................57 5.2.2.16.1 Description .........................................................................................57 5.2.2.16.2 Parameters .........................................................................................57 5.2.2.17 WriteExportFile Service .........................................................................................58 5.2.2.17.1 Description .........................................................................................58 5.2.2.17.2 Parameters .........................................................................................58 Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 7 of 145 5.2.2.18 FinishExportFile Service .........................................................................................58 5.2.2.18.1 Description .........................................................................................58 5.2.2.18.2 Parameters .........................................................................................58 5.2.2.19 InitImportFile Service ............................................................................................59 5.2.2.19.1 Description .........................................................................................59 5.2.2.19.2 Parameters .........................................................................................59 5.2.2.20 ReadImportFile Service ..........................................................................................59 5.2.2.20.1 Description .........................................................................................59 5.2.2.20.2 Parameters .........................................................................................59 5.2.2.21 FinishImportFile Service.........................................................................................60 5.2.2.21.1 Description .........................................................................................60 5.2.2.21.2 Parameters .........................................................................................60 5.2.2.22 InitOpenDefaultApplication Service .......................................................................60 5.2.2.22.1 Description .........................................................................................60 5.2.2.22.2 Parameters .........................................................................................60 5.2.2.23 WriteOpenDefaultApplication Service ....................................................................61 5.2.2.23.1 Description .........................................................................................61 5.2.2.23.2 Parameters .........................................................................................61 5.2.2.24 FinishOpenDefaultApplication Service ...................................................................61 5.2.2.24.1 Description .........................................................................................61 5.2.2.24.2 Parameters .........................................................................................61 5.2.2.25 GetHostingProperties Service ................................................................................62 5.2.2.25.1 Description .........................................................................................62 5.2.2.25.2 Parameters .........................................................................................62 5.2.2.25.3 Key Value Pairs ...................................................................................62 Parameter Type Definitions .......................................................................................63 5.2.3.1 DefaultResult Definition ........................................................................................63 5.2.3.2 ButtonSet ..............................................................................................................63 5.2.3.3 AcknStyle...............................................................................................................64 6 UIP ..............................................................................................................................................................64 6.1 UIP Services .................................................................................................................................64 Services .....................................................................................................................64 6.1.1.1 Activate Service .....................................................................................................64 6.1.1.1.1 Description .........................................................................................64 6.1.1.1.2 Parameters .........................................................................................65 6.1.1.2 Deactivate Service .................................................................................................65 6.1.1.2.1 Description .........................................................................................65 6.1.1.2.2 Parameters .........................................................................................65 6.1.1.3 SetSystemLabel Service .........................................................................................66 6.1.1.3.1 Description .........................................................................................66 6.1.1.3.2 Parameters .........................................................................................66 6.1.1.4 SetTraceLevel Service ............................................................................................66 Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 8 of 145 6.1.1.4.1 Description .........................................................................................66 6.1.1.4.2 Parameters .........................................................................................66 6.1.1.5 GetStandardUIActionItems Service ........................................................................66 6.1.1.5.1 Description .........................................................................................66 6.1.1.5.2 Parameters .........................................................................................66 6.1.1.6 GetSpecificUIActionItems Service ..........................................................................67 6.1.1.6.1 Description .........................................................................................67 6.1.1.6.2 Parameters .........................................................................................67 6.1.1.7 InvokeStandardUIAction Service ............................................................................67 6.1.1.7.1 Description .........................................................................................67 6.1.1.7.2 Parameters .........................................................................................67 6.1.1.8 InvokeSpecificUIAction Service ..............................................................................67 6.1.1.8.1 Description .........................................................................................67 6.1.1.8.2 Parameters .........................................................................................68 Parameter type definitions ........................................................................................68 6.1.2.1 TraceLevel .............................................................................................................68 6.1.2.2 StandardUIAction ..................................................................................................68 6.1.2.3 StandardUIActionItem ...........................................................................................69 6.1.2.4 SpecificUIActionItem .............................................................................................69 6.2 UIP instantiation rules ..................................................................................................................69 6.3 UIP state machine ........................................................................................................................69 States ........................................................................................................................69 State transitions ........................................................................................................70 6.4 UIP permissions and restrictions ..................................................................................................71 Introduction ..............................................................................................................71 Access to local file system .........................................................................................71 Export / Import of files ..............................................................................................71 Inter-Process Communication (IPC) ............................................................................71 Open files based on MIME Type .................................................................................72 Access to ressources ..................................................................................................72 6.5 UIP deployment............................................................................................................................72 UIP downloads from FDI Server .................................................................................72 UIP management on FDI Client ..................................................................................73 7 Actions........................................................................................................................................................73 7.1 General ........................................................................................................................................73 7.2 Sequence diagram ........................................................................................................................74 7.3 FDI Action schema definition ........................................................................................................76 8 User Interface Description (UID) .................................................................................................................77 8.1 Overview ......................................................................................................................................77 8.2 UID execution ..............................................................................................................................79 Annex A (normative) XML schema ......................................................................................................................82 A.1 General .......................................................................................................................................................82 Next >