SMP 2.0 csd01 - SMP-Entities-2.0

Index for all items: ACT ADD CER CON DES END EXP ID PAR PRO PUB RED ROL SER SMP TRA TYP ServiceGroup ServiceMetadata SMP-CommonLibrary-2.0 Unqualified Data Types Summary

Copyright © OASIS Open

Rendering: 20190429-1814z

Legends: Summary Legend: Name (Model line Object) TYPE Description
Table Legend: ^ = up-link to the containing ABIE of the BBIE or the ASBIE (hover to see ABIE name)
< = back-link to the ASBIE using the ABIE, or to the BBIE using the data type (hover to see destination)
Line number links: alternate between summary view and table view

ServiceGroup

Name Card. Rep. Term Dictionary Entry Name Ver. Comp.
Type 		Class Prop. Term
Poss. Noun 		Prop. Term
Prim. Noun 		Prop. Term Data Type Assoc.
Class
2 ServiceGroup
 The ServiceGroup class holds references to the service(s) associated with a specific Participant.
Service Group. Details 2.0 ABIE Service Group
3
^		 SMPVersionID The version of the Service Metadata Publishing specification in use. For SMP 2.0, this value MUST be set to “2.0”.
1 Identifier Service Group. SMP Version Identifier. Identifier 2.0 BBIE Service Group SMP Version Identifier SMP Version Identifier Identifier. Type
4
^		 ParticipantID Represents a business level endpoint key that uniquely identifies a Participant in the network. Examples of identifiers are company registration and VAT numbers, DUNS numbers, GLN numbers, email addresses etc.
1 Identifier Service Group. Participant Identifier. Identifier 2.0 BBIE Service Group Participant Identifier Participant Identifier Identifier. Type
5
^		 ServiceReference The ServiceReference structure holds a list of references to ServiceMetadata structures. From this list, a sender can follow the references to get each ServiceMetadata structure.
0..n Service Reference Service Group. Service Reference 2.0 ASBIE Service Group Service Reference Service Reference

ServiceMetadata

Name Card. Rep. Term Examples Dictionary Entry Name Ver. Comp.
Type 		Class Prop. Term
Poss. Noun 		Prop. Term
Prim. Noun 		Prop. Term Data Type Assoc.
Class
2 ServiceMetadata
 The ServiceMetadata class associates a Participant with a specific document type and the processes and endpoints available for sending the document type to the Participant.
Service Metadata. Details 2.0 ABIE Service Metadata
3
^		 SMPVersionID The version of the Service Metadata Publishing specification in use. For SMP 2.0, this value MUST be set to “2.0”.
1 Identifier Service Metadata. SMP Version Identifier. Identifier 2.0 BBIE Service Metadata SMP Version Identifier SMP Version Identifier Identifier. Type
4
^		 ID A service identifier representing a specific service or document type.
1 Identifier urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##UBL-2.1 Service Metadata. Identifier 2.0 BBIE Service Metadata Identifier Identifier Identifier. Type
5
^		 ParticipantID Represents a business level endpoint key that uniquely identifies a Participant in the network. Examples of identifiers are company registration and VAT numbers, DUNS numbers, GLN numbers, email addresses etc.
1 Identifier Service Metadata. Participant Identifier. Identifier 2.0 BBIE Service Metadata Participant Identifier Participant Identifier Identifier. Type
6
^		 ProcessMetadata Metadata containing information about how to locate the network endpoint for the given Participant.
1..n Process Metadata Service Metadata. Process Metadata 2.0 ASBIE Service Metadata Process Metadata Process Metadata

SMP-CommonLibrary-2.0

This summary of elements only includes those members of the common library that are referenced directly or indirectly by ServiceGroup and ServiceMetadata.
Name Card. Rep. Term Examples Dictionary Entry Name Ver. Comp.
Type 		Class Prop. Term
Poss. Noun 		Prop. Term
Prim. Noun 		Prop. Term Data Type Assoc.
Class
2 Certificate
< < 		The certificate class holds information necessary to validate the signature of the SMP service.
Certificate. Details 2.0 ABIE Certificate
3
^		 TypeCode The use of the certificate being provided, expressed as a user or domain defined code.
0..1 Code Certificate. Type. Code 2.0 BBIE Certificate Type Type Code. Type
4
^		 Description An optional and informal description of the certificate.
0..1 Text Certificate. Description. Text 2.0 BBIE Certificate Description Description Text. Type
5
^		 ActivationDate The date from which the embedded certificate can be used, extracted from the certificate itself or set explicitly by the endpoint.
0..1 Date Certificate. Activation. Date 2.0 BBIE Certificate Activation Activation Date. Type
6
^		 ExpirationDate The date from which the embedded certificate can no longer be used, extracted from the certificate itself or set explicitly by the endpoint.
0..1 Date Certificate. Expiration. Date 2.0 BBIE Certificate Expiration Expiration Date. Type
7
^		 ContentBinaryObject Holds the complete certificate of the recipient endpoint or SMP.
1 Binary Object Certificate. Content. Binary Object 2.0 BBIE Certificate Content Content Binary Object. Type
8 Endpoint
< 		The Endpoint class contains information about the network endpoint of the Participant.
Endpoint. Details 2.0 ABIE Endpoint
9
^		 TransportProfileID Indicates the type of transport method that is being used between access points.
1 Identifier Endpoint. Transport Profile. Identifier 2.0 BBIE Endpoint Transport Profile Transport Profile Identifier. Type
10
^		 Description A human readable description of the endpoint.
0..1 Text Endpoint. Description. Text 2.0 BBIE Endpoint Description Description Text. Type
11
^		 Contact Represents a link to human readable contact information. This might also be an email address.
0..1 Text Endpoint. Contact. Text 2.0 BBIE Endpoint Contact Contact Text. Type
12
^		 AddressURI The address of an endpoint, as a URL.
0..1 Identifier Endpoint. Address URI. Identifier 2.0 BBIE Endpoint Address URI Address URI Identifier. Type
13
^		 ActivationDate Activation date of the service.
0..1 Date Endpoint. Activation. Date 2.0 BBIE Endpoint Activation Activation Date. Type
14
^		 ExpirationDate Expiration date of the service.
0..1 Date Endpoint. Expiration. Date 2.0 BBIE Endpoint Expiration Expiration Date. Type
15
^		 Certificate One or more certificates used to validate the communication with an endpoint.
0..n Certificate Endpoint. Certificate 2.0 ASBIE Endpoint Certificate Certificate
16 Process
< < 		The process class holds information about the process of which the service of the Participant is a part.
Process. Details 2.0 ABIE Process
17
^		 ID The identifier of the process.
1 Identifier bdx:noprocess Process. Identifier 2.0 BBIE Process Identifier Identifier Identifier. Type
18
^		 RoleID May be used to indicate the role of the participant in a process where more than two roles are defined or where distinguishing implicit roles based on service identifier is not possible.
0..n Identifier Process. Role. Identifier 2.0 BBIE Process Role Role Identifier. Type
19 ProcessMetadata
< 		The ProcessMetadata class contains information about how to locate the network endpoint for the given Participant. ProcessMetadata MUST have as a child element either a Redirect element or one or more Endpoint elements. The ProcessMetadata MUST NOT contain an Endpoint element and a Redirect element at the same time.
Process Metadata. Details 2.0 ABIE Process Metadata
20
^		 Process Information about the process of which the service of the participant is a part.
0..n Process Process Metadata. Process 2.0 ASBIE Process Metadata Process Process
21
^		 Endpoint The Endpoint element contains information about the network endpoint of the Participant.
0..n Endpoint Process Metadata. Endpoint 2.0 ASBIE Process Metadata Endpoint Endpoint
22
^		 Redirect The presence of a Redirect element indicates that a client MUST follow the URL in the PublisherURI element of the Redirect class.
0..1 Redirect Process Metadata. Redirect 2.0 ASBIE Process Metadata Redirect Redirect
23 Redirect
< 		The Redirect class holds the information necessary for an SMP client to follow a redirect instruction of an SMP service, and look up the Participant in the SMP Service that is being redirected to.
Redirect. Details 2.0 ABIE Redirect
24
^		 PublisherURI A client MUST follow the URL in the PublisherURI element to get to the SMP holding the information.
1 Identifier Redirect. Publisher URI. Identifier 2.0 BBIE Redirect Publisher URI Publisher URI Identifier. Type
25
^		 Certificate The certificate used to validate information signed by the destination SMP.
0..n Certificate Redirect. Certificate 2.0 ASBIE Redirect Certificate Certificate
26 ServiceReference
< 		The ServiceReference class associates a Participant with a specific service or document type.
Service Reference. Details 2.0 ABIE Service Reference
27
^		 ID A service identifier representing a specific service or document type.
1 Identifier urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##UBL-2.1 Service Reference. Identifier 2.0 BBIE Service Reference Identifier Identifier Identifier. Type
28
^		 Process Information about the process of which the service of the participant is a part.
0..n Process Service Reference. Process 2.0 ASBIE Service Reference Process Process

Unqualified data types

Dict. Entry Name
(Base type XSD) 		Content and supplementary components Cardi-
nality 		Type
(XSD) 		Definition
(property) (attribute)
Amount. Type
(xsd:decimal)
 AmountContent A number of monetary units specified using a given unit of currency.
AmountCurrencyIdentifier currencyID required xsd:normalizedString The currency of the amount.
AmountCurrencyCodeListVersionIdentifier currencyCodeListVersionID optional xsd:normalizedString The VersionID of the UN/ECE Rec9 code list.
Binary Object. Type
(xsd:base64Binary)
 BinaryObjectContent A set of finite-length sequences of binary octets.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the binary object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Graphic. Type
(xsd:base64Binary)
 BinaryObjectContent A diagram, graph, mathematical curve, or similar representation.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the graphic object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Picture. Type
(xsd:base64Binary)
 BinaryObjectContent A diagram, graph, mathematical curve, or similar representation.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the picture object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Sound. Type
(xsd:base64Binary)
 BinaryObjectContent An audio representation.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the sound object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Video. Type
(xsd:base64Binary)
 BinaryObjectContent A video representation.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the video object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Code. Type
(xsd:normalizedString)
< 		CodeContent A character string (letters, figures, or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an attribute, together with relevant supplementary information.
LanguageIdentifier languageID optional xsd:language The identifier of the language used in the code name.
CodeListAgencyIdentifier listAgencyID optional xsd:normalizedString An agency that maintains one or more lists of codes.
CodeListAgencyNameText listAgencyName optional xsd:string The name of the agency that maintains the list of codes.
CodeListIdentifier listID optional xsd:normalizedString The identification of a list of codes.
CodeListNameText listName optional xsd:string The name of a list of codes.
CodeListSchemeUniformResourceIdentifier listSchemeURI optional xsd:anyURI The Uniform Resource Identifier that identifies where the code list scheme is located.
CodeListUniformResourceIdentifier listURI optional xsd:anyURI The Uniform Resource Identifier that identifies where the code list is located.
CodeListVersionIdentifier listVersionID optional xsd:normalizedString The version of the list of codes.
CodeNameText name optional xsd:string The textual equivalent of the code content component.
Date Time. Type
(xsd:dateTime)
 DateTimeContent A particular point in the progression of time, together with relevant supplementary information.
Date. Type
(xsd:date)
< < < < 		DateContent One calendar day according the Gregorian calendar.
Time. Type
(xsd:time)
 TimeContent An instance of time that occurs every day.
Identifier. Type
(xsd:normalizedString)
< < < < < < < < < < < 		IdentifierContent A character string to identify and uniquely distinguish one instance of an object in an identification scheme from all other objects in the same scheme, together with relevant supplementary information.
IdentificationSchemeAgencyIdentifier schemeAgencyID optional xsd:normalizedString The identification of the agency that maintains the identification scheme.
IdentificationSchemeAgencyNameText schemeAgencyName optional xsd:string The name of the agency that maintains the identification scheme.
IdentificationSchemeDataUniformResourceIdentifier schemeDataURI optional xsd:anyURI The Uniform Resource Identifier that identifies where the identification scheme data is located.
IdentificationSchemeIdentifier schemeID optional xsd:normalizedString The identification of the identification scheme.
IdentificationSchemeNameText schemeName optional xsd:string The name of the identification scheme.
IdentificationSchemeUniformResourceIdentifier schemeURI optional xsd:anyURI The Uniform Resource Identifier that identifies where the identification scheme is located.
IdentificationSchemeVersionIdentifier schemeVersionID optional xsd:normalizedString The version of the identification scheme.
Indicator. Type
(xsd:boolean)
 IndicatorContent A list of two mutually exclusive Boolean values that express the only possible states of a property.
Measure. Type
(xsd:decimal)
 MeasureContent A numeric value determined by measuring an object using a specified unit of measure.
MeasureUnitCode unitCode required xsd:normalizedString The type of unit of measure.
MeasureUnitCodeListVersionIdentifier unitCodeListVersionID optional xsd:normalizedString The version of the measure unit code list.
Numeric. Type
(xsd:decimal)
 NumericContent Numeric information that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.
NumericFormatText format optional xsd:string Whether the number is an integer, decimal, real number or percentage.
Value. Type
(xsd:decimal)
 NumericContent Numeric information that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.
NumericFormatText format optional xsd:string Whether the number is an integer, decimal, real number or percentage.
Percent. Type
(xsd:decimal)
 NumericContent Numeric information that is assigned or is determined by calculation, counting, or sequencing and is expressed as a percentage. It does not require a unit of quantity or unit of measure.
NumericFormatText format optional xsd:string Whether the number is an integer, decimal, real number or percentage.
Rate. Type
(xsd:decimal)
 NumericContent A numeric expression of a rate that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.
NumericFormatText format optional xsd:string Whether the number is an integer, decimal, real number or percentage.
Quantity. Type
(xsd:decimal)
 QuantityContent A counted number of non-monetary units, possibly including a fractional part.
QuantityUnitCode unitCode optional xsd:normalizedString The unit of the quantity
QuantityUnitCodeListAgencyIdentifier unitCodeListAgencyID optional xsd:normalizedString The identification of the agency that maintains the quantity unit code list
QuantityUnitCodeListAgencyNameText unitCodeListAgencyName optional xsd:string The name of the agency which maintains the quantity unit code list.
QuantityUnitCodeListIdentifier unitCodeListID optional xsd:normalizedString The quantity unit code list.
Text. Type
(xsd:string)
< < < 		TextContent A character string (i.e. a finite set of characters), generally in the form of words of a language.
LanguageIdentifier languageID optional xsd:language The identifier of the language used in the content component.
LanguageLocaleIdentifier languageLocaleID optional xsd:normalizedString The identification of the locale of the language.
Name. Type
(xsd:string)
 TextContent A character string that constitutes the distinctive designation of a person, place, thing or concept.
LanguageIdentifier languageID optional xsd:language The identifier of the language used in the content component.
LanguageLocaleIdentifier languageLocaleID optional xsd:normalizedString The identification of the locale of the language.

Summary

Copyright © OASIS Open

Rendering: 20190429-1814z

Legends: Summary Legend: Name (Model line Object) TYPE Description
Table Legend: ^ = up-link to the containing ABIE of the BBIE or the ASBIE (hover to see ABIE name)
< = back-link to the ASBIE using the ABIE, or to the BBIE using the data type (hover to see destination)
Line number links: alternate between summary view and table view

ACT

ActivationDate

    
SMP-CommonLibrary-2.0

    
(5 Certificate) BBIE The date from which the embedded certificate can be used, extracted from the certificate itself or set explicitly by the endpoint.
(13 Endpoint) BBIE Activation date of the service.

ADD

AddressURI (12 Endpoint) BBIE The address of an endpoint, as a URL.

CER

Certificate

    
SMP-CommonLibrary-2.0

    
(2) ABIE The certificate class holds information necessary to validate the signature of the SMP service.
(15 Endpoint) ASBIE One or more certificates used to validate the communication with an endpoint.
(25 Redirect) ASBIE The certificate used to validate information signed by the destination SMP.

CON

Contact (11 Endpoint) BBIE Represents a link to human readable contact information. This might also be an email address.
ContentBinaryObject (7 Certificate) BBIE Holds the complete certificate of the recipient endpoint or SMP.

DES

Description

    
SMP-CommonLibrary-2.0

    
(4 Certificate) BBIE An optional and informal description of the certificate.
(10 Endpoint) BBIE A human readable description of the endpoint.

END

Endpoint

    
SMP-CommonLibrary-2.0

    
(8) ABIE The Endpoint class contains information about the network endpoint of the Participant.
(21 ProcessMetadata) ASBIE The Endpoint element contains information about the network endpoint of the Participant.

EXP

ExpirationDate

    
SMP-CommonLibrary-2.0

    
(6 Certificate) BBIE The date from which the embedded certificate can no longer be used, extracted from the certificate itself or set explicitly by the endpoint.
(14 Endpoint) BBIE Expiration date of the service.

ID

ID

    
ServiceMetadata (4) BBIE A service identifier representing a specific service or document type.
SMP-CommonLibrary-2.0

    
(17 Process) BBIE The identifier of the process.
(27 ServiceReference) BBIE A service identifier representing a specific service or document type.

PAR

ParticipantID

    
ServiceGroup (4) BBIE Represents a business level endpoint key that uniquely identifies a Participant in the network. Examples of identifiers are company registration and VAT numbers, DUNS numbers, GLN numbers, email addresses etc.
ServiceMetadata (5) BBIE Represents a business level endpoint key that uniquely identifies a Participant in the network. Examples of identifiers are company registration and VAT numbers, DUNS numbers, GLN numbers, email addresses etc.

PRO

Process

    
SMP-CommonLibrary-2.0

    
(16) ABIE The process class holds information about the process of which the service of the Participant is a part.
(20 ProcessMetadata) ASBIE Information about the process of which the service of the participant is a part.
(28 ServiceReference) ASBIE Information about the process of which the service of the participant is a part.
ProcessMetadata

    
ServiceMetadata (6) ASBIE Metadata containing information about how to locate the network endpoint for the given Participant.
SMP-CommonLibrary-2.0 (19) ABIE The ProcessMetadata class contains information about how to locate the network endpoint for the given Participant. ProcessMetadata MUST have as a child element either a Redirect element or one or more Endpoint elements. The ProcessMetadata MUST NOT contain an Endpoint element and a Redirect element at the same time.

PUB

PublisherURI (24 Redirect) BBIE A client MUST follow the URL in the PublisherURI element to get to the SMP holding the information.

RED

Redirect

    
SMP-CommonLibrary-2.0

    
(23) ABIE The Redirect class holds the information necessary for an SMP client to follow a redirect instruction of an SMP service, and look up the Participant in the SMP Service that is being redirected to.
(22 ProcessMetadata) ASBIE The presence of a Redirect element indicates that a client MUST follow the URL in the PublisherURI element of the Redirect class.

ROL

RoleID (18 Process) BBIE May be used to indicate the role of the participant in a process where more than two roles are defined or where distinguishing implicit roles based on service identifier is not possible.

SER

ServiceGroup (2) ABIE The ServiceGroup class holds references to the service(s) associated with a specific Participant.
ServiceMetadata (2) ABIE The ServiceMetadata class associates a Participant with a specific document type and the processes and endpoints available for sending the document type to the Participant.
ServiceReference

    
ServiceGroup (5) ASBIE The ServiceReference structure holds a list of references to ServiceMetadata structures. From this list, a sender can follow the references to get each ServiceMetadata structure.
SMP-CommonLibrary-2.0 (26) ABIE The ServiceReference class associates a Participant with a specific service or document type.

SMP

SMPVersionID

    
ServiceGroup (3) BBIE The version of the Service Metadata Publishing specification in use. For SMP 2.0, this value MUST be set to “2.0”.
ServiceMetadata (3) BBIE The version of the Service Metadata Publishing specification in use. For SMP 2.0, this value MUST be set to “2.0”.

TRA

TransportProfileID (9 Endpoint) BBIE Indicates the type of transport method that is being used between access points.

TYP

TypeCode (3 Certificate) BBIE The use of the certificate being provided, expressed as a user or domain defined code.
END