OPC UA Specification - Amendment

10001-10

 

OPC Unified Architecture

Amendment 10: Currency

 

 

Release 1.04

2020-03-05

 

 

 

 

 

 


 

Specification Type:

Industry Standard Specification

Comments:

Report or view errata: http://www.opcfoundation.org/errata

 

 

 

 

Document
Number

10001-10

 

 

Title:

OPC Unified Architecture

Amendment 10: Currency

Date:

2020-03-05

 

 

 

 

Version:

Release 1.04

Software:

MS-Word

 

 

Source:

OPC 10001-10 - UA Specification 1.04 Amendment 10 - Currency.docx

 

 

 

 

Author:

OPC Foundation

Status:

Release

 

 

 

 


 

 

OPC Foundation

____________

 

UNIFIED ARCHITECTURE –

FOREWORD

This specification is the specification for developers of OPC UA applications. The specification is a result of an analysis and design process to develop a standard interface to facilitate the development of applications by multiple vendors that shall inter-operate seamlessly together.

Copyright © 2006-2020, OPC Foundation, Inc.

AGREEMENT OF USE

COPYRIGHT RESTRICTIONS

Any unauthorized use of this specification may violate copyright laws, trademark laws, and communications regulations and statutes. This document contains information which is protected by copyright. All Rights Reserved. No part of this work covered by copyright herein may be reproduced or used in any form or by any means--graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems--without permission of the copyright owner.

OPC Foundation members and non-members are prohibited from copying and redistributing this specification. All copies must be obtained on an individual basis, directly from the OPC Foundation Web site https://opcfoundation.org/.

PATENTS

The attention of adopters is directed to the possibility that compliance with or adoption of OPC specifications may require use of an invention covered by patent rights. OPC shall not be responsible for identifying patents for which a license may be required by any OPC specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. OPC specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents.

WARRANTY AND LIABILITY DISCLAIMERS

WHILE THIS PUBLICATION IS BELIEVED TO BE ACCURATE, IT IS PROVIDED "AS IS" AND MAY CONTAIN ERRORS OR MISPRINTS. THE OPC FOUDATION MAKES NO WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, WITH REGARD TO THIS PUBLICATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF TITLE OR OWNERSHIP, IMPLIED WARRANTY OF MERCHANTABILITY OR WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE. IN NO EVENT SHALL THE OPC FOUNDATION BE LIABLE FOR ERRORS CONTAINED HEREIN OR FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, RELIANCE OR COVER DAMAGES, INCLUDING LOSS OF PROFITS, REVENUE, DATA OR USE, INCURRED BY ANY USER OR ANY THIRD PARTY IN CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS MATERIAL, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

The entire risk as to the quality and performance of software developed using this specification is borne by you.

RESTRICTED RIGHTS LEGEND

This Specification is provided with Restricted Rights. Use, duplication or disclosure by the U.S. government is subject to restrictions as set forth in (a) this Agreement pursuant to DFARs 227.7202-3(a); (b) subparagraph (c)(1)(i) of the Rights in Technical Data and Computer Software clause at DFARs 252.227-7013; or (c) the Commercial Computer Software Restricted Rights clause at FAR 52.227-19 subdivision (c)(1) and (2), as applicable. Contractor / manufacturer are the OPC Foundation,. 16101 N. 82nd Street, Suite 3B, Scottsdale, AZ, 85260-1830

COMPLIANCE

The OPC Foundation shall at all times be the sole entity that may authorize developers, suppliers and sellers of hardware and software to use certification marks, trademarks or other special designations to indicate compliance with these materials. Products developed using this specification may claim compliance or conformance with this specification if and only if the software satisfactorily meets the certification requirements set by the OPC Foundation. Products that do not meet these requirements may claim only that the product was based on this specification and must not claim compliance or conformance with this specification.

Trademarks

Most computer and software brand names have trademarks or registered trademarks. The individual trademarks have not been listed here.

GENERAL PROVISIONS

Should any provision of this Agreement be held to be void, invalid, unenforceable or illegal by a court, the validity and enforceability of the other provisions shall not be affected thereby.

This Agreement shall be governed by and construed under the laws of the State of Minnesota, excluding its choice or law rules.

This Agreement embodies the entire understanding between the parties with respect to, and supersedes any prior understanding or agreement (oral or written) relating to, this specification.

ISSUE REPORTING

The OPC Foundation strives to maintain the highest quality standards for its published specifications, hence they undergo constant review and refinement. Readers are encouraged to report any issues and view any existing errata here: HTUhttp://www.opcfoundation.org/errataUTH

 


Revision 1.04 Amendment 10 Highlights

The following table includes the Mantis issues resolved by this Amendment.

Mantis ID

Summary

Resolution

4526

Currency not defined.

Added a Currency Property.

 

 

 

 

 


OPC Unified Architecture Specification

 

AMENDMENT 10: Currency

 

 

OPC 10000-3, OPC Unified Architecture - Part 3: Address Space Model

Add the following reference to Clause 2.

ISO 4217: Codes for the representation of currencies

https://www.iso.org/iso-4217-currency-codes.html

 

 

Add the Currency Property to Table 13 (Variable NodeClass) under section “Standard Properties”) in clause 5.6.2

 

    CurrencyUnit

O

CurrencyUnitType

Only used for DataVariables having a subtype of Number DataType.

Its contents are based on ISO 4217.

See https://www.iso.org/iso-4217-currency-codes.html

The Property CurrencyUnit represents the currency of the value. The information in the structure is designed to be suited for human users and for automated systems.

 

Add the following section to Clause 8 "Standard DataTypes".

8.61     CurrencyUnitType

This structured DataType is used to represent the currency of a Variable Value based on ISO 4217. Its elements are described in Table 43A.

Table 43A – CurrencyUnitType Definition

Name

Type

Description

CurrencyUnitType

structure

 

    numericCode

Int16

Three-digit code numeric code assigned to each currency in ISO 4217.

If unknown or not available this shall be -1.

 

Converting the number to a string shall always produce a 3 digit number with leading zeros when necessary (e.g. the number 36 shall be converted into 036).

    exponent

SByte

Number of digits after the decimal separator.

If unknown or not available this shall be -1.

exponent expresses the relationship between the major currency unit and its corresponding minor currency unit. It assumes a base of 10.

For example, USD (United States dollar) is equal to 100 of its minor currency unit the "cent". So the exponent is 2 (10 to the power 2 is 100).

    alphabeticCode

String

Three-letter alphabetic code as defined by ISO 4217.

    currency

LocalizedText

Full name of currency as defined by ISO 4217.

 

Examples:

numericCode

exponent

alphabeticCode

currency

036

2

AUD

Australian Dollar

978

2

EUR

Euro

356

2

INR

Indian Rupee

840

2

USD

US Dollar

826

2

GBP

Pound Sterling

392

0

JPY

Yen

 

OPC 10000-5, OPC Unified Architecture - Part 5: Information Model

Add the following row to Table 115 “OPC 10000-3 DataType Definitions” in Clause 12.2 “DataTypes defined in OPC 10000-3”.

 

BrowseName

CurrencyUnitType

 

 

Add the following row to Table 117 “Structure Definition” in Clause 12.2 “DataTypes defined in OPC 10000-3”.

 

References

NodeClass

BrowseName

IsAbstract

HasSubtype

DataType

CurrencyUnitType

FALSE

 

 

 

OPC 10000-7, OPC Unified Architecture - Part 7: Profiles

Add the following ConformanceUnits to section 5.4, Table 13 “Base Information”:

Category

Title

Description

Server

Base Info Currency

Support the Currency Property on DataVariables that represent currency.

Client

Base Info Client Currency

Use the Currency Property on DataVariables that represent currency.

 

Add the following ConformanceUnits to the section 6.6.3 Core 2017 Server Facet:

Group

Conformance Unit / Profile Title

Optional

Base Information

Base Info Currency

True

 

Add the following ConformanceUnits to the section 6.6.73 Core 2017 Client Facet:

Group

Conformance Unit / Profile Title

Optional

Base Information

Base Info Client Currency

True

 

____________