Retail_Item business object

The Retail_Item business object is the basic data element carried through collaboration objects based on the Role_Email, Process_Reviewed_Item, ItemDispatcher, UCCnetMessageSend, UCCnetMessageReceive, ItemCollector, ItemValidation, and ItemStore collaboration templates.

The Retail_Item business object contains a detailed description of the item being processed, internal data attributes that are used by the various collaboration objects, specific customer data, a gln list, and optional audit data.. The specific customer data can be customized for each implementation. Also included in the business object is a list of required and missing attributes and their values. This data structure detects attributes that are required to contain valid settings by the implementation's business process, but have no values set.

Selected attributes of the Retail_Item business object are described, including any component child business objects. Links are provided to descriptions of the component child business objects. Each linked section includes a description of the child business object, followed by links to descriptions of any of its attributes which are child business objects.

Note: Certain information contained herein related to UCCnet's function as a global data of record for item, location, and description of product based upon UCCnet's application of the EAN.UCC System, is copyright protected and proprietary property of Uniform Code Council, Inc. and UCCnet, Inc., and is used here with their express permission.

Business object structure

The Retail_Item business object is a hierarchical business object. It includes attributes based on child business objects, which are listed in the table below. Each of the child business objects is described as follows:
Table 1. Attributes for Retail_Item business object
Name Type Key Cardinality Description
item Retailer_item x 1 Structure containing details that describe the item being processed.
internals Retail_internals   1 Structure containing information used by the Product Information Management for Retailers solution to process the item.
customer_data Retail_customer_data   1 Structure containing example data that can be added for a particular implementation.
glnList Retail_glnList   1 Structure containing various gln values provided by the supplier.
audit Retail_Audit   1 Structure containing details that describe a set of fields that can be used to record user information for possible auditing needs.

Retailer_item child business object

The Retailer_item child business object is a hierarchical business object containing details that describe the item being processed. In addition to its String attributes, it includes attributes based on child business objects. Retailer_item and its nested child business objects contain similar attributes, sequence, and structure as the child business objects of the UCCnet® business object UCCnetXSD_envelope_catalogueItemNotification. For full descriptions of these business objects, refer to UCCnet documentation.

All attributes in the Retailer_item child business object are dependent on the data source of the item. The data source can be a user interface, a database, or a catalog that publishes items, such as UCCnet.

Retail_internals child business object

The Retail_internals child business object is a hierarchical business object containing data used by collaboration objects that process the item. It can be modified to fit any implementation. Its attributes are listed in the table below. In addition to String attributes, it includes attributes based on child business objects. Each of the child business objects is described as follows: All attributes in the Retail_internals child business object are dependent on the data source of the item. The data source can be a user interface, a database, or a catalog that publishes items, such as UCCnet.
Name Type Key Cardinality Description
item_status String x 1 State of the item as it passes through the business process. Possible values include:
  • Review
  • Approved
  • Accepted
  • Rejected
  • Error
  • Reprocess
See State descriptions.
item_command String x 1 Command attached to the item. Possible values include:
  • Create
  • Delete
  • Update
correlationID String   1 Identifier used to track the item through asynchronous processing.
originalCorrelationID String   1 Identifier used to track the original message and item through asynchronous processing.
message_text String   1 Message text to be sent in e-mail messages.
message_subject String   1 Message subject to be sent in e-mail messages.
message_recipient_role String   1 Recipients to receive e-mail messages
WF_graph String   1 Could be used to specify the name of the IBM® WebSphere® MQ Workflow process definition to be invoked for business approval. Reserved.
date_processed String   1 Date the item is processed by the reviewers.
time_processed String   1 Time the item is processed by the reviewers.
responder_name String   1 Name of approver or list of approvers.
fromGln String   1 GLN of the supplier publishing the Retail_Item.
toGln String   1 Top-level retailer GLN to which the item is being published.
cascaded String   1 true if the item has cascaded GLNs.
cascadeCount String   1 The count of cascaded GLNs included in the item.
lastCascadedGLN String   1 true if the Retail_Item is the only item or the last item in a group of GLNs to be processed.

If false, the original message should not be deleted yet from the message store.

cascadedGlns Retail_cascadedGlns   N Multiple structure representing the set of retailer GLNs to which to cascade the item.
customer_data_missing_attributes Retail_Missing_Attributes   N Multiple structure representing all the attributes in the item that have been identified to be missing (not containing values).

Retail_cascadedGlns child business object

The Retail_cascadedGlns child business object is used to process multiple GLNs in a single request. This child business object is a flat business object. Its attributes are listed in the table below.

Table 2. Attributes for child business object Retail_cascadedGlns
Name Type Key Cardinality Description
gln String x 1 An owner-generated identifier (referred to as the unique creator ID).
item_status String     State of the item as it passes through the business process. Possible values include:
  • Review
  • Approved
  • Accepted
  • Rejected
  • Error
  • Reprocess
See State descriptions.

Retail_Missing_Attributes child business object

The Retail_Missing_Attributes child business object is an array of name and value pairs. It represents all the attributes in the item that have been identified to be missing (not containing values). The fully qualified attribute name must be used to represent the value of attribute_name. One collaboration object can identify the missing attributes, while another collaboration object can supply the correct values for the attributes. This child business object is a flat business object. Its attributes are listed in the table below.

Table 3. Attributes for child business object Retail_Missing_Attributes
Name Type Key Cardinality Description
attribute_name String x 1 Name of an attribute identified to be missing (not containing a value).
attributeValue String   1 Obtained value for missing attribute.

Retail_customer_data child business object

The Retail_customer_data child business object is a flat business object providing extensions to an item description. These extensions, contained in attributes, can be customized for any implementation. Example attributes are listed in the table below. Their descriptions are self-explanatory. A customized business process must provide the values for the attributes. All attributes in the Retail_customer_data child business object are dependent on the data source of the item. The data source can be a user interface, a database, or a catalog that publishes items, such as UCCnet.

Table 4. Attributes for child business object Retail_customer_data
Name Type Cardinality Key
vendorAddress String 1 x
vendorCity String 1  
vendorStateCode String 1  
vendorZip String 1  
brokerName String 1  
salesRepName String 1  
vendorEIN String 1  
planogramNumber String 1  
reclamationGuarantee String 1  
reclamationBillingAddress String 1  
reclamationBillingCity String 1  
reclamationBillingStateCode String 1  
reclamationBillingZip String 1  
reclamationChuteMethodNumber String 1  
termsOfSalePercent String 1  
termsOfSaleDays String 1  
netDays String 1  
remitToAddress String 1  
remitToCity String 1  
remitToStateCode String 1  
remitToZip String 1  
bracketCost_1 String 1  
bracketConstraintMin_1 String 1  
bracketConstraintMax_1 String 1  
bracketCost_2 String 1  
bracketConstraintMin_2 String 1  
bracketConstraintMax_2 String 1  
bracketCost_3 String 1  
bracketConstraintMin_3 String 1  
bracketConstraintMax_3 String 1  
bracketCost_4 String 1  
bracketConstraintMin_4 String 1  
bracketConstraintMax_4 String 1  
bracketCost_5 String 1  
bracketConstraintMin_5 String 1  
bracketConstraintMax_5 String 1  
bracketCost_6 String 1  
bracketConstraintMin_6 String 1  
bracketConstraintMax_6 String 1  
bracketCost_7 String 1  
bracketConstraintMin_7 String 1  
bracketConstraintMax_7 String 1  

Retail_glnList child business object

The Retail_glnList child business object contains various gln values provided by the supplier for use primarily by the item synchronization solution. This child business object is a flat business object. Its attributes are listed in the table below.
Table 5. Attributes for child business object Retail_glnList
Name Type Cardinality Key Description
fromGln String 1 x Supplier's gln value
toGln Retail_toGln N   List of gln's to which the item should be published
dataPoolName String     Name of the data pool

State descriptions

This section describes the possible states of an item as it passes through the business process.
Review
The item has started the business processing, but has not yet completed its validation stage.
Approved
The item has passed business processing checks and is ready for its final destination.
Accepted
The item has been temporarily accepted but will be sent back for business process approval. This state lets the supplier know that the retailer has looked at the item, but has not performed final approval.
Rejected
The item did not pass the approval process and was rejected for business reasons.
Error
A system error occurred while processing the item.
Reprocess
The item was not approved or rejected. It will be sent back for business process approval. This state is used when collecting missing data which needs to be validated.

Supported verbs

The Retail_Item business object supports the following verbs:
  • Request Processing (sending to the destination application): Create, Retrieve, Update, and Delete
  • Event Notification (receiving from the source application): Create, Retrieve, Update, and Delete

Examining the object

To examine a listing of the attributes of the Retail_Item business object, use the System Manager or Business Object Designer.

Related information

For more information on related business objects and collaboration templates, see the following:

Parent topic: PIMR business objects