< PreviousField Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 109 of 145 <xs:element name="DisplayUnit" type="xs:boolean" default="true" minOccurs="0"/> <xs:element name="PreEditActionList" type="clnt:ActionListT" minOccurs="0"/> <xs:element name="PostEditActionList" type="clnt:ActionListT" minOccurs="0"/> <xs:element name="ScalingFactor" type="xs:double" minOccurs="0"/> <xs:element name="Class" type="clnt:ParameterClassT" minOccurs="0"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> The elements of a ParameterT type are described in Table A.47. Table A.47 – Elements of ParameterT Element Description UITemplate This element specifies the complex UI template used to display a parameter. UI templates modify how parameter values are displayed. The default UI template displays a parameter value as plain text. Unit This optional element specifies the engineering unit of the parameter. The default is the parameter has no engineering unit. Handling This optional element specifies whether or not the parameter may be modified. The default is ReadWrite. RangeList This optional element specifies the minimum and maximum values to which the user may set the parameter. DisplayFormat This optional element specifies the format to be used when displaying the value of the parameter as specified in FCG TS61804-3. The default is dependent upon the data type of the parameter and is determined by the FDI Client. EditFormat This optional element specifies the format to be used when modifying the value of the parameter as specified in FCG TS61804-3. The default is dependent upon the data type of the parameter and is determined by the FDI Client. TimeFormat This optional element specifies the format to be used when displaying and modifying the value of parameters of date or time types. TimeScale This optional element specifies the TIME_SCALE of parameters of date or time types. DisplayLabel This optional element specifies whether or not the parameter's label should be displayed. The default is true. DisplayValue This optional element specifies whether or not the parameter's value should be displayed. The default is true. DisplayUnit This optional element specifies whether or not the parameter's unit should be displayed. The default is true. PreEditActionList This optional element specifies the Actions to be executed before the parameter is modified by the user. PostEditActionList This optional element specifies the Actions to be executed after the parameter is modified by the user. ScalingFactor This element specifies the scaling factor to be used when the value of the parameter will be shown to the user. This visible value is the result of the multiplication of the factor and the parameter value, returned by the device. Class This optional element specifies the EDD CLASS attribute of VARIABLE. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 110 of 145 A.50 PluginT This type specifies a User Interface Plug-in that is referenced from a user interface element such as a Window or Dialog. The XML schema for a PluginT type is: <xs:complexType name="PluginT"> <xs:complexContent> <xs:extension base="clnt:UiElementT"> <xs:sequence> <xs:element name="Identifier"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:pattern value="[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA- F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"/> </xs:restriction> </xs:simpleType> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> The elements of a PluginT type are described in Table A.48. Table A.48 – Elements of PluginT Element Description Identifier This required element specifies the Universally Unique Identifer (UUID) that identifies the plug-in. A.51 RangeListT This type specifies a list of Range elements. The XML schema for a RangeListT type is: <xs:complexType name="RangeListT"> <xs:sequence maxOccurs="unbounded"> <xs:element name="Range" type="clnt:RangeT"/> </xs:sequence> </xs:complexType> The elements of a RangeListT type are described in Table A.49. Table A.49 – Elements of RangeListT Element Description Range An element of the list. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 111 of 145 A.52 RangeT This type specifies a range defined by a minimum and a maximum value. The XML schema for a RangeT type is: <xs:complexType name="RangeT"> <xs:sequence> <xs:element name="MinimumValue" type="clnt:VariantT"/> <xs:element name="MaximumValue" type="clnt:VariantT" minOccurs="0"/> </xs:sequence> </xs:complexType> The elements of a RangeT type are described in Table A.50. Table A.50 – Elements of RangeT Element Description MinimumValue This required element specifies the minimum value of the range. MaximumValue This required element specifies the maximum value of the range. A.53 ResponseT This type specifies the response sent by an FDI Client to an FDI Server as a result of processing an Action request. The XML schema for a ResponseT type is: <xs:complexType name="ResponseT"/> A.54 RowBreakT This type specifies a row break. The XML schema for a RowBreakT type is: <xs:complexType name="RowBreakT"/> A.55 ScalingT This type specifies a method of scaling values from a lower bound to an upper bound. The XML schema for a ScalingT enumeration type is: <xs:simpleType name="ScalingT"> <xs:restriction base="xs:string"> <xs:enumeration value="Linear"/> <xs:enumeration value="Logarithmic"/> </xs:restriction> </xs:simpleType> The enumeration values of a ScalingT enumeration type are described in Table A.51. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 112 of 145 Table A.51 – Enumerations of ScalingT Enumeration Description Linear The values are scaled linearly. Logarithmic The values are scaled logarithmically via the natural logarithm. A.56 SelectionRequestT This type specifies a request sent from an FDI Server to an FDI Client when the user needs to choose from a list of options during an Action. Once the user has selected one of the options, the FDI Client sends an SelectionResponse back to the FDI Server. The XML schema for a SelectionRequestT type is: <xs:complexType name="SelectionRequestT"> <xs:sequence> <xs:element name="Prompt" type="xs:string"/> <xs:element name="OptionList" type="clnt:OptionListT"> <xs:unique name="UniqueOptionIdentifier"> <xs:selector xpath="clnt:Option/clnt:Label"/> <xs:field xpath="."/> </xs:unique> </xs:element> </xs:sequence> </xs:complexType> The elements of a SelectionRequestT type are described in Table A.52. Table A.52 – Elements of SelectionRequestT Element Description Prompt This required element specifies the prompt to be displayed to the user. OptionList This required element specifies the list of options the user may select from. A.57 SelectionResponseT This type specifies the response sent by an FDI Client to an FDI Server as a result of processing an SelectionRequest. The XML schema for a SelectionResponseT type is: <xs:complexType name="SelectionResponseT"> <xs:sequence> <xs:element name="SelectedOption" type="xs:unsignedLong"/> </xs:sequence> </xs:complexType> The elements of a SelectionResponseT type are described in Table A.53. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 113 of 145 Table A.53 – Elements of SelectionResponseT Element Description SelectedOption The 0-based index of the selected option. A.58 SeparatorT This type specifies a separator. The XML schema for a SeparatorT type is: <xs:complexType name="SeparatorT"/> A.59 SizeT This type specifies the relative size of an item. The XML schema for a SizeT enumeration type is: <xs:simpleType name="SizeT"> <xs:restriction base="xs:string"> <xs:enumeration value="XXX_SMALL"/> <xs:enumeration value="XX_SMALL"/> <xs:enumeration value="X_SMALL"/> <xs:enumeration value="SMALL"/> <xs:enumeration value="MEDIUM"/> <xs:enumeration value="LARGE"/> <xs:enumeration value="X_LARGE"/> <xs:enumeration value="XX_LARGE"/> </xs:restriction> </xs:simpleType> The enumeration values of a SizeT enumeration type are described in Table A.54. Table A.54 – Enumerations of SizeT Enumeration Description XXX_SMALL Extra extra extra small. XX_SMALL Extra extra small. X_SMALL Extra small. SMALL Small. MEDIUM Medium. LARGE Large. X_LARGE Extra large. XX_LARGE Extra extra large. A.60 ParameterClassT This type specifies the EDD CLASS type definition for VARIABLE. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 114 of 145 The XML schema for a ParameterClassT enumeration type is: <xs:simpleType name="ParameterClassT"> <xs:list> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="ALARM"/> <xs:enumeration value="ANALOG_INPUT"/> <xs:enumeration value="ANALOG_OUTPUT"/> <xs:enumeration value="COMPUTATION"/> <xs:enumeration value="CONSTANT"/> <xs:enumeration value="CONTAINED"/> <xs:enumeration value="CORRECTION"/> <xs:enumeration value="DEVICE"/> <xs:enumeration value="SPECIALIST"/> <xs:enumeration value="DIAGNOSTIC"/> <xs:enumeration value="DIGITAL_INPUT"/> <xs:enumeration value="DIGITAL_OUTPUT"/> <xs:enumeration value="DISCRETE_INPUT"/> <xs:enumeration value="DISCRETE_OUTPUT"/> <xs:enumeration value="DYNAMIC"/> <xs:enumeration value="FREQUENCY_INPUT"/> <xs:enumeration value="FREQUENCY_OUTPUT"/> <xs:enumeration value="HART"/> <xs:enumeration value="INPUT"/> <xs:enumeration value="IS_CONFIG"/> <xs:enumeration value="LOCAL"/> <xs:enumeration value="LOCAL_DISPLAY"/> <xs:enumeration value="OPERATE"/> <xs:enumeration value="OPTIONAL"/> <xs:enumeration value="OUTPUT"/> <xs:enumeration value="SERVICE"/> <xs:enumeration value="TEMPORARY"/> <xs:enumeration value="TUNE"/> </xs:restriction> </xs:simpleType> </xs:list> </xs:simpleType> The enumeration values of a ParameterClassT enumeration type are described in Table A.55. Table A.55 – Enumerations of ParameterClassT Enumeration Description ALARM The VARIABLE contains alarm limits. ANALOG_INPUT The VARIABLE is part of an analog input block. ANALOG_OUTPUT The VARIABLE is part of an analog output block. COMPUTATION The VARIABLE is part of a computation block. CONSTANT The VARIABLE is constant. CONTAINED The VARIABLE represents the physical characteristics of the device. CORRECTION The VARIABLE is part of the correction block. DEVICE The VARIABLE represents the physical characteristics of the device. SPECIALIST The VARIABLE is a configuration parameter. Permission to modify this Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 115 of 145 VARIABLE may only be granted to users that are specialists for this device. DIAGNOSTIC The VARIABLE indicates the device status. DIGITAL_INPUT The VARIABLE is part of a digital input block. DIGITAL_OUTPUT The VARIABLE is part of a digital output block. DISCRETE_INPUT The VARIABLE is part of a discrete input block. DISCRETE_OUTPUT The VARIABLE is part of a discrete output block. DYNAMIC The VARIABLE is modified by the device without stimulus from the network. FREQUENCY_INPUT The VARIABLE is part of a frequency input block. FREQUENCY_OUTPUT The VARIABLE is part of a frequency output block. HART The VARIABLE is part of the HART block which characterizes the HART interface. INPUT The VARIABLE is part of an input block. IS_CONFIG A modification of the VARIABLE results in setting the revision counter or configuration-changed bit, as applicable. LOCAL The VARIABLE is locally used by the EDD application LOCAL_DISPLAY The VARIABLE is part of the local display block. OPERATE The VARIABLE is used to control a block’s operation. OPTIONAL The VARIABLE may not be present in the device. OUTPUT The VARIABLE is part of the output block. SERVICE The VARIABLE is used when performing routine maintenance. TEMPORARY The VARIABLE is initialized to its DEFAULT_VALUE in each EDD application session. LOCAL variables may be persisted by the EDD application; TEMPORARY variables are never persisted. TUNE The VARIABLE is used to tune the algorithm of a block A.61 ActionClassT This type specifies the EDD CLASS definition of an Action The XML schema for an ActionClassT enumeration type is: <xs:simpleType name="ActionClassT"> <xs:list> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="ALARM"/> <xs:enumeration value="ANALOG_OUTPUT"/> <xs:enumeration value="BACKGROUND"/> <xs:enumeration value="COMPUTATION"/> <xs:enumeration value="CONTAINED"/> <xs:enumeration value="CORRECTION"/> <xs:enumeration value="DEVICE"/> <xs:enumeration value="SPECIALIST"/> <xs:enumeration value="DIAGNOSTIC"/> <xs:enumeration value="DISCRETE"/> <xs:enumeration value="FREQUENCY"/> <xs:enumeration value="HART"/> <xs:enumeration value="INPUT"/> Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 116 of 145 <xs:enumeration value="LOCAL_DISPLAY"/> <xs:enumeration value="OPERATE"/> <xs:enumeration value="OUTPUT"/> <xs:enumeration value="SERVICE"/> <xs:enumeration value="TUNE"/> </xs:restriction> </xs:simpleType> </xs:list> </xs:simpleType> The enumeration values of an ActionClassT enumeration type are described in Table A.56. Table A.56 – Enumerations of ActionClassT Enumeration Description ALARM The METHOD is associated with an alarm (e.g., specifying alarm limits, indicating alarm status, etc.) ANALOG_OUTPUT The METHOD is part of an analog output block. BACKGROUND CLASS BACKGROUND is provided to enhance the simulation of a device using its EDD. In all EDD applications other than Simulators, this class shall be ignored. CLASS BACKGROUND METHODS shall not belong to any other CLASS. CLASS BACKGROUND shall only be used in METHODS and, when used, indicates the Simulator shall periodically execute the METHOD. All METHODS of CLASS BACKGROUND shall be run at the monotonic period specified by the VARIABLE background_period. The METHOD shall not be run during a packet handling operation (i.e., between the time the request packet arrives and the corresponding response packet has been dispatched to the communications handler). If the background_period expires during this interval then the METHOD shall be run as soon as the command response is generated. COMPUTATION The METHOD is part of a computation block. CONTAINED The METHOD represents the physical characteristics of the device. CORRECTION The METHOD supports the transducers in the field device. The METHOD may establish transducer limits, provide signal damping, indicate the transducer's value, linearize or calibrate the transducer, etc. DEVICE The METHOD specifies the physical characteristics of the device. SPECIALIST Permission to execute this METHOD may only be granted to users that are specialists for this device. DIAGNOSTIC The METHOD evaluates the device status. DISCRETE The METHOD supports the discrete and or digital I/O of the device. FREQUENCY The METHOD supports the frequency I/O of the device. HART The METHOD is part of the HART block which characterizes the HART interface. There is only one HART block. INPUT The METHOD is part of an input block. An input block is a special kind of computation block which does unit conversions, scaling, and damping. The input block parameters can be determined by the output of another block. LOCAL_DISPLAY The METHOD is part of the local display block. A local display block contains the VARIABLEs associated with the local interface (keyboard, display, etc.) of the device. OPERATE The METHOD is used to control a block’s operation. OUTPUT The METHOD is part of the output block. The values of output parameters may be accessed by another block input. Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2 , Ed. 1.2.0, 27 Jun 2019 Page 117 of 145 SERVICE The METHOD is used when performing routine maintenance. TUNE The METHOD is used to tune the algorithm of a block. A.62 SourceListT This type specifies a list of Source elements. The XML schema for a SourceListT type is: <xs:complexType name="SourceListT"> <xs:sequence maxOccurs="unbounded"> <xs:element name="Source" type="clnt:SourceT"/> </xs:sequence> </xs:complexType> The elements of a SourceListT type are described in Table A.57. Table A.57 – Elements of SourceListT Element Description Source An element of the list. A.63 SourceT This type specifies a source of data values displayed by a chart. The XML schema for a SourceT type is: <xs:complexType name="SourceT"> <xs:complexContent> <xs:extension base="clnt:DiagramLineT"> <xs:sequence> <xs:element name="ParameterList" type="clnt:ParameterListT"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> The elements of a SourceT type are described in Table A.58. Table A.58 – Elements of SourceT Element Description ParameterList This required element specifies the parameters to be sampled and displayed. A.64 StringDataT This type specifies that data type of a string value. The XML schema for a StringDataT enumeration type is: Field Device Integration (FDI) – Part 2: Client RELEASED FCG TS62769-2, Ed. 1.2.0, 27 Jun 2019 Page 118 of 145 <xs:simpleType name="StringDataT"> <xs:restriction base="xs:string"> <xs:enumeration value="ASCII"/> <xs:enumeration value="BITSTRING"/> <xs:enumeration value="EUC"/> <xs:enumeration value="PACKED_ASCII"/> <xs:enumeration value="PASSWORD"/> <xs:enumeration value="VISIBLE"/> <xs:enumeration value="OCTET"/> </xs:restriction> </xs:simpleType> The enumeration values of a StringDataT enumeration type are described in Table A.59. Table A.59 – Enumerations of StringDataT Enumeration Description ASCII String of ASCII characters. BITSTRING Variables of data type BIT_ENUMERATED are string constants which identify the position of a character of the VARIABLE value with its position. EUC (Extended Unit code) – is the internal code for specific characters (for example, China: EUC-CN, Taiwan EUC-TW). EUC is used to handle East Asian languages (ISO/IEC 10646-1). PACKED_ASCII Is a subset of ASCII produced by removing the two most significant bits of each ASCII character. PASSWORD Is a string type and is intended for specifying password strings. Except for how the variable is presented to the user, password and ASCII string types are identical. VISIBLE This string is an ordered sequence of characters from the ISO/IEC 10646-1 and ISO/IEC 2375 character set. OCTET Is for specifying a sequence of unformatted binary data whose definition is determined by the implementation of the device. A.65 StringTemplateT This type specifies the template used to display a string parameter value. The XML schema for a StringTemplateT type is: <xs:complexType name="StringTemplateT"> <xs:sequence> <xs:element name="DataType" type="clnt:StringDataT"/> <xs:element name="Options" type="clnt:StringOptionListT" minOccurs="0" maxOccurs="1"> <xs:unique name="UiTemplateUniqueStringValue"> <xs:selector xpath="clnt:Option/clnt:Value"/> <xs:field xpath="."/> </xs:unique> </xs:element> </xs:sequence> </xs:complexType> The elements of a StringTemplateT type are described in Table A.60. Next >