Aggregation

Marketing Authorization Holders (MAHs) and Importers that own Kazakhstan Compliance can generate an Aggregation report to capture the serial numbers that are applied to the products.

If the shipment contains only Eaches and there is no aggregation, the Aggregation report is not generated.

Configure the report

Aggregation

The event triggers (i.e. workflow subscriptions) for the report can be set in Administer solution for Kazakhstan Compliance. Make sure one of the following event triggers are enabled:

Source Application Event Action Description
Serialized Operations Manager Shipment Generate Aggregation Report for Export Sales from Core Integration

TraceLink generates an Aggregation report for sales shipments exported to Kazakhstan when they are submitted via core integration or the Web UI, as long as all of the event trigger conditions are met.
Serialized Operations Manager Shipment Generate Aggregation Report for Export Sales from ESM Integration TraceLink generates an Aggregation report for sales shipments exported to Kazakhstan when they are submitted via ESM integration as long as all of the event trigger conditions are met.
Serialized Operations Manager Shipment Generate Aggregation Report for Export Transfers from Core Integration TraceLink generates an Aggregation Report for sales shipments to Kazakhstan when they are submitted via core integration or the Web UI, as long as all of the event trigger conditions are met.
Serialized Operations Manager Shipment Generate Aggregation Report for Export Transfers from ESM Integration TraceLink generates an Aggregation Report for sales shipments to Kazakhstan when they are submitted via ESM integration as long as all of the event trigger conditions are met.

For more information on how to enable the event triggers, see the Administer Help Center.

Kazakhstan Compliance generates the Aggregation report when TraceLink processes a Product Shipped - Export Transfer, ESM Product Shipped - Export Transfer, Product Shipped - Export Sale, or an ESM Product Shipped - Export Sale event, and the following conditions are met in the interface where the event occurred:

  • The products have a Packaging Code Type of GTIN-14 with a Packaging UOM (unit of measure) of Each.
  • In Product Master Data, the serialized item is associated with an Item Code that has a Target Market of Kazakhstan.
  • The Ship From Country Code is not KZ.
  • The Ship To Country Code is KZ.

Generate the report

To generate the Aggregation report automatically, enable the appropriate event triggers and ensure that the relevant event trigger conditions are met in Master Data Exchange. When configured, Kazakhstan Compliance generates the Aggregation report automatically when Aggregation occurs in one of the following interfaces:

Use any of the following Serialized Operations Manager API message to trigger the Utilisation report:

Sales Shipment (EPCIS v1.2)

Complete the elements required for the report as follows. See the Serialized Operations Manager Core Integration API Guide for more information.

Element Values
VocabularyElement

Must include:

  • A ship from location with a name, address, and identifier.
  • A ship to location with a name, address, and identifier.

The locations can also be specified in the sourceList or destinationList for the shipment event as a master data lookup.

tl:shipToCountryCode KZ
tl:shipFromCountryCode The tl:shipFromCountryCode is not KZ.
tl:salesDistributionType EXPORTTRANSFER or EXPORTSALE

Sales Shipment (XML)

Complete the elements required for the report as follows. See the Serialized Operations Manager Core Integration API Guide for more information.

Element Values
cmn:ShipToCountryCode KZ
cmn:ShipFromCountryCode The cmn:ShipFromCountryCode is not KZ.
cmn:SalesDistributionType EXPORTTRANSFER or EXPORTSALE

ESM Sales Shipment (EPCIS v1.2)

Complete the elements required for the report as follows. See the Serialized Operations Manager ESM Synchronization API Guide for more information.

Element Values
VocabularyElement

Must include:

  • A ship from location with a name, address, and identifier.
  • A ship to location with a name, address, and identifier.

The locations can also be specified in the sourceList or destinationList for the shipment event as a master data lookup.

tl:shipToCountryCode KZ
tl:shipFromCountryCode The tl:shipFromCountryCode is not KZ.
tl:salesDistributionType EXPORTTRANSFER or EXPORTSALE

ESM Sales Shipment (XML)

Complete the elements required for the report as follows. See the Serialized Operations Manager ESM Synchronization API Guide for more information.

Element Values
VocabularyElement

Must include:

  • A ship from location with a name, address, and identifier.
  • A ship to location with a name, address, and identifier.

The locations can also be specified in the sourceList or destinationList for the shipment event as a master data lookup.

cmn:ShipToCountryCode KZ
cmn:ShipFromCountryCode The cmn:ShipFromCountryCode is not KZ.
cmn:SalesDistributionType EXPORTTRANSFER or EXPORTSALE

Shipment Event (EPCIS v1.2)

Complete the elements required for the report as follows. See the Serialized Operations Manager Trade Partner Event Exchange API Guide for more information.

Element Values
VocabularyElement

Must include:

  • A ship from location with a name, address, and identifier.
  • A ship to location with a name, address, and identifier.

The locations can also be specified in the sourceList or destinationList for the shipment event as a master data lookup.

cmn:ShipToCountryCode KZ
cmn:ShipFromCountryCode The cmn:ShipFromCountryCode is not KZ.
cmn:SalesDistributionType EXPORTTRANSFER or EXPORTSALE

Use Serialized Operations Manager to trigger the Aggregation report from the Web UI. See the Serialized Operations Manager Online Help for more information.

  1. In Track & Trace Services, hover over Modules, and then select Serialized Operations Manager.
  2. Expand the Outbound Movement drop-down, and then select Create Delivery.
  3. Select the manufacturing location that provisioned the serial numbers from the Show Data From drop-down in the upper right.
  4. Complete the fields required for the report as follows:
    FieldValues
    Delivery Number Specify the delivery number of the shipment to generate the report for.
    Sale TypeSale - Export or Transfer - Export.
    Ship From Country Code

    The Ship From Country is not KZ.

    Ship To Country CodeKZ.
    Ship To LocationSpecify a Ship To Location.
  5. Complete any other fields that are required in the UI or that your company uses for a specific purpose.
  6. Select Submit.

    The View Deliveries screen displays, the shipment is added, and Kazakhstan Compliance begins automatically generating the report from the event trigger.

Use the Kazakhstan Compliance Web UI to manually generate the Aggregation report. This option is useful if a report failed to generate automatically, and the information must still be submitted to the Order Management Station (OMS).

  1. Select the Main Menu icon.
  2. Select Kazakhstan Compliance from the main menu.

    A new tab opens and displays information for the Kazakhstan Compliance app.

  3. Select the Generate Report icon.
  4. Fill in the following fields:
    • Report Type drop-down – Required. Select Aggregation as the Report Type.
    • Delivery Number field – Required. The delivery number of the shipment to generate the report for. If more than one shipment has the same delivery number, provide the following additional details:
      • Ship From Business field – Required. The business that shipped the product.
      • Ship From Location field – Conditionally required if more than one shipment has the same Ship From Business. The location that the delivery is shipped from.

  5. Select Generate.

    The panel closes, and TraceLink begins generating the report. Filter to find the new report.

Report details

Field Description Sourced From OMS Report Element
Report Type Displays as Aggregation. The type of report. Not reported
Status

The status of the report.

  • Generated – The report is generated in TraceLink but not yet submitted to the OMS.
  • Generation Failed – The report failed to generate in TraceLink.
  • Submitted – The report is generated and successfully submitted to the OMS.
  • Submission Failed – The report is generated but was not successfully submitted to the OMS.
  • Failed – The OMS received the report successfully but failed to provide a response.
  • Accepted – The OMS received the report successfully and accepted the information.
  • Partially Accepted – The event has multiple reports, and all of them are successfully submitted to the OMS, but the OMS did not accept all of the reports.
  • Rejected – The OMS received the report successfully but rejected the information.

The status of the report.

Not reported
OMS ID The associated GUID. TraceLink obtains this value from the OMS. Order Management Station Identifier. omsId
Date Reported The date and time that the report is generated. The system date and time when the report is generated. Not reported
Delivery Number The delivery number associated with the shipment. The Delivery Number for the shipment in Serialized Operations Manager. Not reported
Event Type

Displays as Shipment.

 The type of event. Not reported
Date Shipped The date and time that the shipment is sent. The date and time that the shipment is sent. Not reported
Participant ID The Kazakhstan Taxpayer Identification Number (TIN). The Item Code in Product Master Data. participantId
Field Description Sourced From OMS Report Element
Packaging Code The packaging code for the product. The Packaging Code of the serialized item in the shipment.

Not reported
Product Description The name of the product. The description associated with the Packaging Code in Product Master Data.

Not reported
Lot Number The lot number associated with the packaging code used to report the serial numbers. The lot number associated with the Packaging Code in Serialized Operations Manager for this product's serialized items. lotNumber

 
Expiration Date The expiration date for the serialized items. The expiration date in Serialized Operations Manager for the serial numbers in this lot. expirationDate

 
Quantity The quantity of serial numbers for the Packaging Code and Lot Number. The quantity of serial numbers in the shipment for the Packaging Code and Lot Number. Not reported

Tips

  • Select the Export icon to export the serial numbers for a Packaging Code and Lot Number to a CSV file.
  • Serial Number – The serial number at the top-level of aggregation in the shipment.
  • Packaging Level – The packaging level of the Serial Number (e.g. Case).
  • Child Quantity – The quantity of child serial numbers aggregated to the parent Serial Number.
  • Aggregation Type – The type of aggregation. Displays as Aggregation.
  • Parent Packaging Capacity – The capacity of the parent packaging code captured from Product Master Data, if available. If not, this value is the total number of children aggregated to the parent.

Tips

  • Select the Export icon to export the serial numbers and their child information to a CSV file.
  • Select the Action icon to view information about the Serial Number and its children.

    Aggregation Information

    • Parent Serial Number – The parent serial number that the child serial numbers are aggregated to.
    • Packaging Level – The packaging level of the Parent Serial Number (e.g. Case).
    • Serial Numbers – Select the file name to export the child serial numbers aggregated to the Parent Serial Number as a CSV file.
    • Child Quantity – The number of child serial numbers aggregated to the Parent Serial Number.

    Child Serial Numbers

    • Serial Number – The child serial numbers aggregated to the Parent Serial Number.
    • Packaging Level – The packaging level of the Serial Number.
    • Child Quantity – The quantity of child serial numbers aggregated to the Serial Number. Displays a value only if the serial number has a Packaging Level of Case or Pallet.
    • Packaging Code – The packaging code for the child serial number.
    • Product Description – The name of the product.
    • Lot Number – The lot number that the serial number belongs to. Displays a value only if the serial number has a Packaging Level of Each.
    • Production Line ID – The production line number of the highest parent.
    • Expiration Date – The expiration date associated with the Lot Number. Displays a value only if the serial number has a Packaging Level of Each.

    Tips:

    • Select the Action icon, and then select View Aggregation to view information about the Serial Number and its children.
    • Select the Action icon, and then select Export Aggregation to export the child serial numbers aggregated to the parent Serial Number as a CSV file.

Response information when using the message status query service to get the status of the report from OMS:

  • Status – The status returned by the OMS for the submitted compliance report.
  • Report Name – The name of the compliance report submitted to the OMS.
  • Status Code – The HTTPS code returned by the OMS for the submitted compliance report.
  • Report ID – The unique ID returned by the OMS for the submitted compliance report.
  • Response Date – The date the response is received from the OMS.
  • Description – The description returned by the OMS for the submitted compliance report.

Tips

  • Select the Action icon, and then select Export Report File to export the report file generated for the OMS.
  • Select the Action icon, and then select Export Response File to export the response file received from the OMS.