|
ATTRIBUTE VALUE
PAIR EXTENSION v. 2.1 |
|
|
|
|
|
Problem
Statement |
|
|
The business need is to
deliver a simple technical solution to transport
non-standard attributes in the GDSN using standard messages.
|
|
|
Objective |
|
|
The objective is to introduce Attribute / Value Pairs (A/VP)
as
the solution to the business problem and to describe the benefits of
using
A/VPs. A/VPs are a single
schema “template”
of data structures. A/VPs provide a user with the ability to exchange
new attributes
and their values in XML through the use of the template. Suppliers,
retailers
and other sending partners now have the capability to include
high-priority
attributes in transmitted XML documents immediately upon approval
– without
waiting on the development and approval of attribute-specific schemas
to be
finalized through the standards process. Recipient data pools and
trading
partners may pull expected attribute names and their value pairs from
the GDD
and use the template to parse their XML documents.
|
|
|
Audience |
|
|
The
audience of this document would be any participant in the Global Data
Synchronization Network (GDSN), including retailers, manufacturers,
data pools,
service providers, Member Organizations and third parties. This
document will
be particularly of interest to members and participants of the:
|
|
|
- GS1 GDSN Business Users Group
- GS1 GDSN Task Group
- GDSN Extended Attributes Team
- GS1 New Item Forms Automation Team
- GS1 Extended Attributes / New Item Forms Team
and
- Any other member and participant working with
A/VPs.
|
|
|
Business
Context
|
|
|
Industry:
All
Geopolitical: All
Product:
All
Process: All
System
Capabilities: All
Official
Constraints: None
|
|
|
Business
Transaction View
|
|
|
This Business Transaction View is
described by the business requirements of a business practice between
trading
partners needing to exchange attributes that have not completed the
full
standardization process. For business reasons, these attributes need to
be exchanged
in a quick and flexible method. In the future, these attributes
may be passed in the GDSN in a standard format. For each
retailer’s attribute,
the attribute name and definition are provided as well as additional
detail as
found in the GDD Fast Track Attributes, namely:
|
|
|
| Attribute Name |
Rationale |
Business Purpose Rule
Rationale |
| Definition |
Field Length Min |
Validation Rules |
| Example |
Field Length Max |
Level of Item Hierarchy
Effected |
| Data Type |
Maximum Usage |
Existing GDD Equivalent NOT
IN Catalog Item Notification |
|
|
|
An A/VP is a single schema “template” of data
structures allowing for the parsing of new attributes and their values
in XML.
In Figure 1, the blue area represents the FT attributes already
approved and
located on the GDD FT site. These attributes – RFID
Indicator, EAN Format and
EAN Code – are now ready to be transmitted in the Global Data
Synchronization
Network (GDSN) as A/VPs. The Supplier’s application, shown in
the orange area,
makes use of one of these attributes – RFID Indicator. The
application uses the
A/VP schema template to create the extension to the Catalogue Item
Notification
(CIN) message, rendered in green. In the XML instance of the extension,
the
Supplier populates the Attribute tag with the attribute name
– “RFID Indicator”
– and the Value tag with the value they wish to send for the
RFID Indicator –
“1”. The CIN with the RFID Indicator is
published to the Retailer. The retailer, shown in yellow, receives the
CIN data
along with the RFID Indicator and its’ value. |
|
|
 |
|
|
Figure
1. What are A/VPs? |
|
|
Business
Transaction Use Case
Diagram |
|
|
Not available
|
|
|
Use
Case
Description
|
|
|
Not applicable |
|
|
Business
Transaction Activity Diagram |
|
|
Not available
|
|
|
|
|
|
Business
Transaction Sequence Diagram |
|
|
Not available |
|
|
This technical document reflects the
generic usage of the Attribute / Value Pair extension. However, for
those
readers interested in an implementation example describing the Use Case
for
applying A/VPs in an administrative process for transporting
non-standard attributes,
the following use case has been provided. This use case is for
illustrative
purposes and transporting of non-standard attributes should not be
construed as
the only application of A/VPs in GDSN. |
|
|
Appendix |
|
|
| Use Case ID
|
UC-1 for the Use of A/VPs to Transmit
Non-Standard Attributes in a Standard Message
|
| Use Case Name
|
The Transmission of Non-Standard Attributes in
a Standard Message Use Case |
| Use Case
Description |
This use case describes how to implement the
transmission of non-standard attributes within the GDSN in an approved
standard manner, using standard messages.
|
| Actors (Goal)
|
Supplier
Retailer
Recipient
Data Pool
Source
Data Pool |
| Performance Goals
|
To make possible the sending of new
non-standard attributes through the GDSN.
|
| Preconditions
|
The trading partners and certified data pools
are capable of transmitting a Catalogue Item Notification (CIN)
message. The Retailer trading partner has posted their valid retailer
specific attributes, definitions and other critical information on
their part of the retailer specific page.
|
| Post conditions
|
|
| Scenario
|
Begins when...
A
supplier is exchanging a CIN message with the retailer and needs to
know what additional non-standard information the retailer requires to
fulfil the function. For example, the supplier maybe exchanging new
product information and has included the attribute names and their
values for the GDD Fast Track New Item Forms. Now the supplier needs to
know whether there are additional retailer specific attributes that the
retailer needs to successfully automate the New Item Form with complete
data.
Continues with...
| Step #
|
Actor
|
Activity Step
|
| 1
|
Supplier
|
The Supplier
accesses the link at: http://gdd.gs1.org/GDD/public/default.asp
and navigates to the part of the page dedicated to the retailer the
supplier is working with. The supplier scans the list of attributes and
navigates to the spreadsheet containing the definitions and details.
|
| 2
|
Supplier
|
The supplier
selects the attributes which are key to the information to be exchanged
or which are noted as key attributes by the retailer and creates a
communication to the data pool including these attribute names and
their values. The communication between the supplier and the data pool
may be in any format: manual or automatic; EDI, XML, or any other
technical format already in use between the supplier and their
certified data pool. |
| 3
|
Supplier or Data
Pool |
Either the
supplier or the receiving Source Data Pool needs to format the
communication into a valid GS1 A/VP.
One of them will create an XML CIN
message containing the Retailer Specific Attributes. This portion of
the XML message must successfully validate against the CIN schema and
must be located in the extension part of the CIN. .
|
| 4
|
Source Data Pool
|
The Source Data
Pool ensures that the CIN XML message is valid and passes through
Retailer Specific Attributes to the Recipient Data Pool without
validating them. Validation of the A/VP can optionally be done as a
value added service by the Source Data Pool should a specific attribute
be owned by a member of the Source Data Pool.
|
| 5
|
Recipient Data
Pool |
The Recipient
Data Pool passes through Retailer Specific Attributes to the Retailer
without validating them. Validation of A/VPs can optionally be done as
a value added service by the Recipient Data Pool should specific
attributes be owned by a member of the Recipient Data Pool.
|
| 6
|
Retailer
|
The Retailer
accepts the CIN and processes it along with the non-standard
attributes. |
Ends when... The Retailer
has successfully received the non-standard attributes in the CIN and in
the case of the New Item Forms example, the New Item Form has been
successfully automatically populated using data from the GDSN.
|
| Alternative
Scenario |
NA
|
| Related
Requirements |
NA
|
| Related Rules
|
NA
|
|
|
|
Implementation Considerations |
|
|
Test
Data |
|
|
|
|
|
TOP
|
|
|
|
|