< PreviousField Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 89 of 145 Table A.13 – Elements of ButtonListT Element Description Button An element of the button list. A.15 ChartT This type specifies a chart that graphically displays data from a device. The data is read from the device periodically and continuously. As new data arrives, it is displayed. The XML schema for a ChartT type is: <xs:complexType name="ChartT"> <xs:complexContent> <xs:extension base="clnt:UiElementSizeableT"> <xs:sequence> <xs:element name="Length" type="xs:nonNegativeInteger" default="600000" minOccurs="0"/> <xs:element name="Type" type="clnt:ChartTypeT" default="Strip" minOccurs="0"/> <xs:element name="CycleTime" type="xs:nonNegativeInteger" default="1000" minOccurs="0"/> <xs:element name="AxisList" type="clnt:AxisListT"> <xs:key name="AxisKey"> <xs:selector xpath="clnt:Axis"/> <xs:field xpath="@Name"/> </xs:key> </xs:element> <xs:element name="SourceList" type="clnt:SourceListT"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> The elements of a ChartT type are described in Table A.14. Table A.14 – Elements of ChartT Element Description Length This optional element specifies the length of time, in milliseconds, that is displayed by the chart. The number of samples displayed by a chart can be calculated by dividing the Length by the CycleTime. The default is 600 000. Type This optional element specifies the type of the chart. The default is Strip. CycleTime This optional element specifies the rate, in milliseconds, at which data on the chart is updated. The default is 1 000. AxisList This required element specifies the vertical axis data displayed by the chart. SourceList This required element specifies the data displayed by the chart. A.16 ChartTypeT This type specifies the general appearance and behavior of a chart. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 90 of 145 The XML schema for a ChartTypeT enumeration type is: <xs:simpleType name="ChartTypeT"> <xs:restriction base="xs:string"> <xs:enumeration value="Gauge"/> <xs:enumeration value="HorizontalBar"/> <xs:enumeration value="Scope"/> <xs:enumeration value="Strip"/> <xs:enumeration value="Sweep"/> <xs:enumeration value="VerticalBar"/> </xs:restriction> </xs:simpleType> The enumeration values of a ChartTypeT enumeration type are described in Table A.15. Table A.15 – Enumerations of ChartTypeT Enumeration Description Gauge A single source value is displayed as a gauge, which is a graphical representation similar to the fuel gauge in an automobile. HorizontalBar The source values are displayed as horizontal bars. Scope The source values are displayed as a curve moving from left to right. When the source values reach the far right of the display area, the display area is erased and the new source values are displayed beginning at the far left. Strip The source values are displayed as a curve moving from left to right. When the source values reach the far right of the display area, the display area is scrolled with the source values on the far left being removed and the new source values being displayed on the right. Sweep The source values are displayed as a curve moving from left to right. When the source values reach the far right of the display area, the new source values are displayed beginning at the far left, but unlike Scope only the portion of the display area needed to display the new source values is erased. VerticalBar The source values are displayed as vertical bars. A.17 ColorNameT This type specifies the name of a predefined color. The XML schema for a ColorNameT enumeration type is: <xs:simpleType name="ColorNameT"> <xs:restriction base="xs:string"> <xs:enumeration value="Agua"/> <xs:enumeration value="Black"/> <xs:enumeration value="Blue"/> <xs:enumeration value="Fuchsia"/> <xs:enumeration value="Gray"/> <xs:enumeration value="Green"/> <xs:enumeration value="Lime"/> <xs:enumeration value="Maroon"/> <xs:enumeration value="Navy"/> <xs:enumeration value="Olive"/> <xs:enumeration value="Purple"/> <xs:enumeration value="Red"/> Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 91 of 145 <xs:enumeration value="Silver"/> <xs:enumeration value="Teal"/> <xs:enumeration value="White"/> <xs:enumeration value="Yellow"/> </xs:restriction> </xs:simpleType> The enumeration values of a ColorNameT enumeration type are described in Table A.16. Table A.16 – Enumerations of ColorNameT Enumeration Description Agua RGB value #00FFFF. Black RGB value #000000. Blue RGB value #0000FF. Fuchsia RGB value #FF00FF. Gray RGB value #808080. Green RGB value #008000. Lime RGB value #00FF00. Maroon RGB value #800000. Navy RGB value #000080. Olive RGB value #808000. Purple RGB value #800080. Red RGB value #FF0000. Silver RGB value #C0C0C0. Teal RGB value #008080. White RGB value #FFFFFF. Yellow RGB value #FFFF00. A.18 ColorT This type specifies a color, either a name or an RGB value. The XML schema for a ColorT type is: <xs:simpleType name="ColorT"> <xs:union memberTypes="clnt:ColorNameT clnt:ColorValueT"/> </xs:simpleType> A.19 ColorValueT This type specifies an RBG value consisting of a hash character (#) followed by three or six hexadecimal digits. If three hexadecimal digits are specified, each character is repeated, for example, #F0F is equivalent to #FF00FF. The XML schema for a ColorValueT type is: <xs:simpleType name="ColorValueT"> <xs:restriction base="xs:string"> <xs:pattern value="#[0-9a-fA-F]{3}"/> Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 92 of 145 <xs:pattern value="#[0-9a-fA-F]{6}"/> </xs:restriction> </xs:simpleType> A.20 ColumnBreakT This type specifies a column break. The XML schema for a ColumnBreakT type is: <xs:complexType name="ColumnBreakT"/> A.21 DateTimeDataT This type specifies the data type of a date/time value. The XML schema for a DateTimeDataT enumeration type is: <xs:simpleType name="DateTimeDataT"> <xs:restriction base="xs:string"> <xs:enumeration value="Date"/> <xs:enumeration value="Time"/> <xs:enumeration value="DateTime"/> <xs:enumeration value="Duration"/> <xs:enumeration value="TimeValue"/> </xs:restriction> </xs:simpleType> The enumeration values of a DateTimeDataT enumeration type are described in Table A.17. Table A.17 – Enumerations of DateTimeDataT Enumeration Description Date A value that represents a date without a time. Time A value that represents a time without a date. DateTime A value that represents a date and time. Duration A value that represents a length of time. TimeValue A value that represents a time of the day A.22 DelayMessageRequestT This type specifies a request sent from an FDI Server to an FDI Client when a delay occurs within an Action. The FDI Client informs the user of the reason for the delay and expected duration of the delay. The FDI Client then sends an ActionResponse back to the FDI Server. The FDI Server may send DelayMessageRequests frequently with updated information regarding the length of the delay. When the delay is finished, the FDI Server sends a DelayMessageRequest with the SecondsToWait element set to zero. The XML schema for a DelayMessageRequestT type is: <xs:complexType name="DelayMessageRequestT"> <xs:sequence> <xs:element name="Message" type="xs:string"/> <xs:element name="SecondsToWait" type="xs:unsignedLong"/> Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 93 of 145 </xs:sequence> </xs:complexType> The elements of a DelayMessageRequestT type are described in Table A.18. Table A.18 – Elements of DelayMessageRequestT Element Description Message This required element specifies the message to be displayed to the user. SecondsToWait This required element specifies the number of seconds the delay is expected to last. A.23 DiagramLineT This type specifies an abstract source The XML schema for a DiagramLineT type is: <xs:complexType name="DiagramLineT" abstract="true"> <xs:complexContent> <xs:extension base="clnt:UiElementT"> <xs:sequence> <xs:element name="Emphasis" type="xs:boolean" default="false" minOccurs="0"/> <xs:element name="LineColor" type="clnt:ColorT" minOccurs="0"/> <xs:element name="LineType" type="clnt:LineTypeT" minOccurs="0"/> <xs:element name="VerticalAxis" minOccurs="0"> <xs:complexType> <xs:attribute name="AxisRef" type="xs:string"/> </xs:complexType> </xs:element> <xs:element name="InitActionList" type="clnt:ActionListT" minOccurs="0"/> <xs:element name="RefreshActionList" type="clnt:ActionListT" minOccurs="0"/> <xs:element name="ExitActionList" type="clnt:ActionListT" minOccurs="0"/> </xs:sequence> <xs:attribute name="Name" type="xs:string" use="required"/> </xs:extension> </xs:complexContent> </xs:complexType> The attributes of a DiagramLineT type are described in Table A.19. Table A.19 – Attributes of DiagramLineT Attribute Description Name Unique name of DiagramlineT in the context of Chart/Graph that this DiagramlineT is present. The elements of a DiagramLineT type are described in Table A.20. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 94 of 145 Table A.20 – Elements of DiagramLineT Element Description Emphasis This optional element specifies whether or not this data should be graphically emphasized. The default is false. LineColor This optional element specifies the color in which to display the data. The default is determined by the FDI Client. LineType This optional element specifies the type of line to be displayed. Every data with the same LineType should be displayed in the same fashion (line pattern, line thickness, etc). VerticalAxis This optional element specifies appearance of the vertical axis. Sn1p1t InitActionList This optional element specifies the Actions to be executed before the data is displayed. RefreshActionList This optional element specifies the Actions to be executed after the data is read from the device but before it is displayed. ExitActionList This optional element specifies the Actions to be executed when the graph or chart containing the data is closed. A.24 EnumerationItemListT This type specifies the content of an enumeration The XML schema for an EnumerationItemListT type is: <xs:complexType name="EnumerationItemListT"> <xs:sequence maxOccurs="unbounded"> <xs:element name="EnumerationItem" type="clnt:EnumerationItemT"/> </xs:sequence> </xs:complexType> The elements of an EnumerationItemListT type are described in Table A.21. Table A.21 – Elements of EnumerationItemListT Element Description EnumerationItem An element of the enumeration. A.25 EnumerationItemT This type specifies one of the possible values of an enumerated value. The XML schema for an EnumerationItemT type is: <xs:complexType name="EnumerationItemT"> <xs:complexContent> <xs:extension base="clnt:LabelHelpT"> <xs:sequence> <xs:element name="Value" type="xs:unsignedLong"/> </xs:sequence> </xs:extension> Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 95 of 145 </xs:complexContent> </xs:complexType> The elements of an EnumerationItemT type are described in Table A.22. Table A.22 – Elements of EnumerationItemT Element Description Value This required element specifies the unique identifier of the list entry in the context of the parent list element. A.26 FormatSpecifierT This type specifies the allowed format specifier of parameters (ANSI C compatible) The XML schema for a FormatSpecifierT type is: <xs:simpleType name="FormatSpecifierT"> <xs:restriction base="xs:string"> <xs:pattern value="%?[#-0+ ]*\d*(\.\d*)?[hlL]?[dioxXucsfeEgGpn%]"/> </xs:restriction> </xs:simpleType> A.27 GraphT This type specifies a graph that graphically displays a finite data set from a device. The XML schema for a GraphT type is: <xs:complexType name="GraphT"> <xs:complexContent> <xs:extension base="clnt:UiElementSizeableT"> <xs:sequence> <xs:element name="CycleTime" type="xs:nonNegativeInteger" default="0" minOccurs="0"/> <xs:element name="AxisList" type="clnt:AxisListT"> <xs:key name="GraphAxisKey"> <xs:selector xpath="clnt:Axis"/> <xs:field xpath="@Name"/> </xs:key> </xs:element> <xs:element name="HorizontalAxis" minOccurs="0"> <xs:complexType> <xs:attribute name="AxisRef" type="xs:string"/> </xs:complexType> </xs:element> <xs:element name="WaveformList" type="clnt:WaveformListT"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> The elements of a GraphT type are described in Table A.23. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 96 of 145 Table A.23 – Elements of GraphT Element Description CycleTime This optional element specifies the rate, in milliseconds, at which data set is re-read from the device and re-displayed. If the CycleTime is 0, the graph is never refreshed. The default is 0. AxisList This required element contains all the axises referred from graph or waveform. HorizontalAxis Sn1p1t WaveformList This required element specifies the waveforms displayed on the graph. A.28 GridT This type specifies a grid that displays data in a table-like grid. The XML schema for a GridT type is: <xs:complexType name="GridT"> <xs:complexContent> <xs:extension base="clnt:UiElementSizeableT"> <xs:sequence> <xs:element name="Handling" type="clnt:HandlingT" default="rw" minOccurs="0"/> <xs:element name="Orientation" type="clnt:OrientationT" default="Vertical" minOccurs="0"/> <xs:element name="VectorList" type="clnt:VectorListT"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> The elements of a GridT type are described in Table A.24. Table A.24 – Elements of GridT Element Description Handling This optional element specifies whether or not the data within the grid may be modified. The default is ReadWrite. Orientation This optional element specifies whether the vectors are displayed horizontally or vertically. The default is Vertical. VectorList This required element specifies the data displayed within the grid. A.29 HandlingT This type specifies how an item may be accessed (ro = read only, wo = write only, rw = read and write). The XML schema for a HandlingT enumeration type is: <xs:simpleType name="HandlingT"> <xs:restriction base="xs:string"> <xs:enumeration value="rw"/> Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 97 of 145 <xs:enumeration value="wo"/> <xs:enumeration value="ro"/> </xs:restriction> </xs:simpleType> The enumeration values of a HandlingT enumeration type are described in Table A.25. Table A.25 – Enumerations of HandlingT Enumeration Description rw The item may only be read. wo The item may only be written. ro The item may be read or written. A.30 ImageT This type specifies a visual entity such as a picture or illustration. The XML schema for an ImageT type is: <xs:complexType name="ImageT"> <xs:complexContent> <xs:extension base="clnt:UiElementT"> <xs:sequence> <xs:element name="Inline" type="xs:boolean" default="false" minOccurs="0"/> <xs:element name="AlignLeft" type="xs:boolean" default="false" minOccurs="0"/> <xs:element name="AlignRight" type="xs:boolean" default="false" minOccurs="0"/> <xs:element name="Link" minOccurs="0"> <xs:complexType> <xs:choice> <xs:element name="Menu" type="clnt:MenuReferenceT"/> <xs:element name="Plugin" type="clnt:PluginT"/> <xs:element name="Action" type="clnt:ActionT"/> </xs:choice> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="NodePath" type="xs:string" use="required"/> </xs:extension> </xs:complexContent> </xs:complexType> The attributes of an ImageT type are described in Table A.26. Table A.26 – Attributes of ImageT Attribute Description NodePath This is a mandatory attribute which gives the qualified path of the Node in the Device Model. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 98 of 145 The elements of an ImageT type are described in Table A.27. Table A.27 – Elements of ImageT Element Description Inline If the image is in a window, dialog, page or group and the inline qualifier is not specified, the image should span with the width of the MENU; otherwise, the image should be displayed inline with other layoutitems of the itemlist. AlignLeft If the image is in a window, dialog, page or group and the inline qualifier is not specified, the image should span with the width of the MENU; otherwise, the image should be displayed inline with other layoutitems of the itemlist. AlignRight If the image is in a window, dialog, page or group and the inline qualifier is not specified, the image should span with the width of the MENU; otherwise, the image should be displayed inline with other layoutitems of the itemlist. Link This optional element specifies a link to Window, Dialog, Menu, Table, or Action related to the image. A.31 InfoRequestT This type specifies a request sent from an FDI Server to an FDI Client when a message needs to be displayed to the user needs during an Action. Unlike an AcknowledgementRequest, when receiving an InfoRequest the FDI Client does not wait for the user to acknowledge the message. Once the message has been displayed, the FDI Client immediately sends an InfoResponse back to the FDI Server. The XML schema for an InfoRequestT type is: <xs:complexType name="InfoRequestT"> <xs:sequence> <xs:element name="Message" type="xs:string"/> </xs:sequence> </xs:complexType> The elements of an InfoRequestT type are described in Table A.28. Table A.28 – Elements of InfoRequestT Element Description Message This required element specifies the message to be displayed to the user. A.32 InputRequestT This type specifies a request sent from an FDI Server to an FDI Client when the user needs to modify a value during an Action. Once the user has finished modifying the value, the FDI Client sends an InputResponse back to the FDI Server. The XML schema for an InputRequestT type is: <xs:complexType name="InputRequestT"> <xs:sequence> <xs:element name="Prompt" type="xs:string"/> <xs:element name="InputValue" type="clnt:InputValueT"/> </xs:sequence> Next >