What's Published in the Publication Payload
This table lists the payload that's published for a spoke system. The Publication Criteria column specifies what you define in the spoke system and the Options column specifies the published content.
Publication Criteria |
Options |
---|---|
Objects |
|
Item entities |
|
Item class entities |
|
Item catalog entities |
|
Trading partner item entities |
|
Extended Item Data
You can use the Request ID and Object Version Number attributes to improve integration capabilities. The values are provided in the object headers of the published XML.
-
The value of Object Version Number is used by integrated solutions to indicate whether the object is newly created or is updated. A value of
1
indicates that the object was newly created. Each time the object is updated, the value is incremented by 1.The XML attribute name is:
ObjectVersionNumber
-
The value of Request ID is generated when content is imported through the item batch infrastructure, and is published as part of the publication payload. You can use the ID to filter the published items.
The XML attribute name is:
RequestId
-
Here's an example of a payload, edited to focus on
ObjectVersionNumber
andRequestId
:<:ns1:Item ...> <:ns1:ItemNumber>TJG_Pack1_020<:/ns1:ItemNumber> ... <:ns1:Pack> <:ns14:ItemNumber>TJG_Pack1_020<:/ns14:ItemNumber> ... <:ns14:ObjectVersionNumber>2<:/ns14:ObjectVersionNumber> <:ns14:RequestId>51412<:/ns14:RequestId> ... <:ns14:PackComponent> <:ns14:ComponentItemNumber>TJG_Base1_020<:/ns14:ComponentItemNumber> ... <:/ns14:PackComponent> <:/ns1:Pack> <:/ns1:Item>
Here are the entities on which RequestId and ObjectVersionNumber are added in the publication payload:
-
Catalog
-
Category
-
Item
-
ItemCategory
-
ItemCrossReference
-
ItemRevision
-
ItemSupplierAssociation
-
ItemSupplierEffCategory
-
Pack
-
RelatedItem
-
Structure
-
SupplierItemXref
-
SysItemXref
-
TradingPartnerItem
Common Structure
The CommonStructure
record represents common structure among items.
The publication structure record contains a record
named CommonStructure
. This record
shows details of each item that the master structure was copied from
or created from, enabling integration logic to add a copy of the master
structure to each item.
The CommonStructure
record enables integration to update the referencing common items
from the changes in the referenced master common item, for scenarios
where the target system for the integration requires a copy of the
master item structure at each of the items that reference the master
item structure.
Here's an example of a publication payload, edited
to focus on CommonStructure
records,
which are highlighted here by doubled asterisks (**
):
<Items ... >
<ns1:Item ... >
<ns1:OrganizationCode>V1</ns1:OrganizationCode>
<ns1:ItemNumber>STR_Header_Primary</ns1:ItemNumber>
<ns1:ItemDescription>STR_Header_Primary-Desc</ns1:ItemDescription>
...
<ns1:Structure ... >
<ns14:BillSequenceId>300100544404018</ns14:BillSequenceId>
<ns14:OrganizationCode>V1</ns14:OrganizationCode>
<ns14:ItemNumber>STR_Header_Primary</ns14:ItemNumber>
<ns14:StructureName>Primary</ns14:StructureName>
<ns14:Description>Primary Structure for Common Publication</ns14:Description>
<ns14:CommonItemNumber>STR_Header_Primary</ns14:CommonItemNumber>
<ns14:CommonOrganizationCode>V1</ns14:CommonOrganizationCode>
<ns14:SourceItemNumber>STR_Header_Primary</ns14:SourceItemNumber>
<ns14:SourceOrganizationCode>V1</ns14:SourceOrganizationCode>
...
<ns14:Component ... >
...
<ns14:ComponentDFF>
...
</ns14:ComponentDFF>
</ns14:Component>
<ns14:StructureDFF>
...
</ns14:StructureDFF>
** <ns14:CommonStructure>
<ns14:BillSequenceId>300100544406846</ns14:BillSequenceId>
<ns14:Description>Primary Structure for Common Publication</ns14:Description>
<ns14:ItemId>300100544403990</ns14:ItemId>
<ns14:OrganizationId>204</ns14:OrganizationId>
<ns14:ItemNumber>STR_Header_Common_1</ns14:ItemNumber>
<ns14:OrganizationCode>V1</ns14:OrganizationCode>
<ns14:ItemDescription>STR_Header_Common_1_Desc</ns14:ItemDescription>
...
</ns14:CommonStructure>
** <ns14:CommonStructure>
<ns14:BillSequenceId>300100544406933</ns14:BillSequenceId>
<ns14:Description>Primary Structure for Common Publication</ns14:Description>
<ns14:ItemId>300100544403992</ns14:ItemId>
<ns14:OrganizationId>204</ns14:OrganizationId>
<ns14:ItemNumber>STR_Header_Common_2</ns14:ItemNumber>
<ns14:OrganizationCode>V1</ns14:OrganizationCode>
<ns14:ItemDescription>STR_Header_Common_2-Desc</ns14:ItemDescription>
...
</ns14:CommonStructure>
</ns1:Structure>
</ns1:Item>
</Items>