Shipment

Pharmaceutical Manufacturers that own UAE Compliance can generate a Shipment report to capture the sale of products in UAE.

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

Shipment reports currently support a maximum of 65,000 serial numbers.

Configure the report

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

Source Application Event Action Description
Serialized Operations Manager Shipped Generate Shipment Report for In Country Sales from Core Integration

TraceLink generates a Shipment report for the sale of the products within UAE 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 Shipped Generate Shipment Report for In Country Sales from ESM Integration

TraceLink generates a Shipment report for the sale of the products within UAE when they are submitted via ESM integration as long as all of the event trigger conditions are met.
Serialized Operations Manager Shipped Generate Shipment Report for Export Sales from Core Integration TraceLink generates a Shipment Report for sales shipments exported to UAE 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 Shipped Generate Shipment Report for Export Sales from ESM Integration TraceLink generates a Shipment Report for sales shipments exported to UAE when they are submitted via ESM integration as long as all of the event trigger conditions are met.

For more information about how to configure UAE compliance and add users, see the Administer Help Center.

UAE Compliance generates the Shipment report when TraceLink processes a Product Shipped - Export Sale, ESM Product Shipped - Export Sale, Product Shipped - In-Country Sale, or ESM Product Shipped - In-Country Sale event and all of the following conditions are met:

  • The products have a Target Market of AE.
  • The products have a Packaging Code Type of GTIN-14 with a Packaging UOM (unit of measure) of Each.
  • The shipment's Sale Type is Sale - Export and Ship From Country Code is not AE
  • The shipment's Sale Type is Sale - In Country and Ship From Country Code is AE.
  • The Ship To Country Code is AE.

Generate the report

To generate the Shipment report automatically, enable the appropriate event triggers and ensure that the relevant event trigger conditions are met. When configured, UAE Compliance generates the Shipment report automatically when a shipment occurs in one of the following interfaces:

Use any of the following Serialized Operations Manager APIs to trigger the Shipment report:

ESM 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.

bizTransactionList Delivery Number associated with the shipment and at least one transaction identifier.
  • IMPORTPERMIT for EXPORTSALE.
  • SALESPERMIT for INCOUNTRYSALE.
tl:shipToCountryCode AE.
tl:shipFromCountryCode
  • The tl:shipFromCountryCode is not AE for EXPORTSALE.
  • The tl:shipFromCountryCode is AE for INCOUNTRYSALE.
tl:salesDistributionType EXPORTSALE or INCOUNTRYSALE.

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.

bizTransactionList

Delivery Number associated with the shipment and at least one transaction identifier.

  • IMPORTPERMIT for EXPORTSALE.
  • SALESPERMIT for INCOUNTRYSALE.
tl:shipToCountryCode AE.
tl:shipFromCountryCode

  • The tl:shipFromCountryCode is not AE for EXPORTSALE.

  • The tl:shipFromCountryCode is AE for INCOUNTRYSALE.
tl:salesDistributionType EXPORTSALE or INCOUNTRYSALE.

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:DeliveryNumber The delivery number associated with the shipment.
cmn:TransactionIdentifier
  • The cmn:TransactionIdentifier is IMPORTPERMIT for EXPORTSALE.
  • The cmn:TransactionIdentifier is SALESPERMIT for INCOUNTRYSALE.
cmn:ShipToCountryCode AE.
cmn:ShipFromCountryCode
  • The cmn:shipFromCountryCode is not AE for EXPORTSALE.
  • The cmn:shipFromCountryCode is AE for INCOUNTRYSALE.
cmn:SalesDistributionType EXPORTSALE or INCOUNTRYSALE.

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.

bizTransactionList

Delivery Number associated with the shipment and at least one transaction identifier.

  • IMPORTPERMIT for EXPORTSALE.
  • SALESPERMIT for INCOUNTRYSALE.
tl:ShipToCountryCode AE.
tl:ShipFromCountryCode
  • The tl:shipFromCountryCode is not AE for EXPORTSALE.
  • The tl:shipFromCountryCode is AE for INCOUNTRYSALE.
tl:saleDistributionType EXPORTSALE or INCOUNTRYSALE.

Update Order Shipment (SOAP)

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

Element Values
deliveryNumber The delivery number associated with the shipment.
ShipToCountryCode AE
ShipFromCountryCode
  • The ShipFromCountryCode is not AE for EXPORTSALE.
  • The ShipFromCountryCode is AE for INCOUNTRYSALE.
SaleType EXPORTSALE or INCOUNTRYSALE.
Transactions

The transaction identifier associated with the shipment.

  • The OrderType is IMPORTPERMIT for EXPORTSALE.
  • The OrderType is SALESPERMIT for INCOUNTRYSALE.

Use Serialized Operations Manager to trigger the Shipment 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 Sale - In Country.
    Ship From Country Code

    • If the Sale Type is Sale - In Country, specify the Ship From Country as AE.

    • If the Sale Type is Sale - Export, the Ship From Country is not AE.

    Ship To Country CodeAE.
    Ship To LocationSpecify a Ship To Location.
    Transaction IDs

    • If the Sale Type is Sale - In Country, specify the Transaction IDs as Sales Permit.

    • If the Sale Type is Sale - Export, specify the Transaction IDs as Import Permit.

  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 UAE Compliance begins automatically generating the report from the event trigger.

Use Smart Inventory Tracker to trigger the Shipment report from a mobile device. See the Smart Inventory Tracker Help Center for more information.

  1. In the Smart Inventory Tracker mobile app, do one of the following:
    • Ship product with an existing delivery number. The delivery number must already exist in Serialized Operations Manager with the fields required for the report.

      Create a new delivery in Smart Inventory Tracker only if reporting Fit for Consumption as True.

    • Create a new delivery to ship product.
  2. If creating a new delivery in Smart Inventory Tracker, complete the following steps:
    1. 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 Sale - In Country.
      Ship From Country

      • If the Sale Type is Sale - In Country, specify the Ship From Country as AE.

      • If the Sale Type is Sale - Export, the Ship From Country is not AE.

      Ship To CountryAE.
      Ship To LocationSpecify a Ship To Location.
      Transaction IDs

      • If the Sale Type is Sale - In Country, specify the Transaction IDs as Sales Permit.

      • If the Sale Type is Sale - Export, specify the Transaction IDs as Import Permit.

    2. Complete any other fields that are required in the UI or that your company uses for a specific purpose.
  3. Select Submit.

    Smart Inventory Tracker takes the resulting action, and UAE Compliance begins automatically generating the report from the event trigger.

To generate the Shipment report manually, use the UAE Compliance Web UI. This option is useful if a report fails to generate automatically and the information must still be submitted to the Tatmeen system.

  1. Select the Main Menu icon .
  2. Select UAE Compliance.

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

  3. Select the Generate Report icon.
  4. Fill in the following fields:
    • Report Type drop-down – Required. Select Shipment as 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 Tatmeen Report Element
Report Type Displays as Shipment. 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 Tatmeen system.
  • Generation Failed – The report failed to generate in TraceLink.
  • Submitted – The report is generated and successfully submitted to the Tatmeen system.
  • Partially Submitted – The event contains more than 49,500 serial numbers, so TraceLink split the serial numbers into multiple reports, but all of the reports are not successfully submitted to the Tatmeen system.
  • Submission Failed – The report is generated but was not successfully submitted to the Tatmeen system.
  • Accepted – The Tatmeen system received the report successfully and accepted the information.
  • Accepted with Warning – The Tatmeen system received the report successfully and accepted the information but issued a warning.
  • Partially Accepted – The event has multiple reports, and all of them are successfully submitted to the Tatmeen system, but the Tatmeen system did not accept all of the reports.
  • Rejected – The Tatmeen system received the report successfully but rejected the information.

At this time, this field does not capture the status response from the Tatmeen system (e.g. Accepted, Accepted with Warning, Rejected).

The status of the report.

Not reported
Date Reported The date and time that the report is generated. The system date and time when the report is generated. Not reported
Document ID The unique report identifier generated by TraceLink. The unique identifier generated by TraceLink. InstanceIdentifier
Report Sender GLN The SGLN of the location where the product is shipped from. The Ship From Location in the shipment. <Sender><Identifier>
Report Receiver GLN The SGLN of the location where the product is shipped to.

The SGLN is always the Tatmeen system GLN.

The Ship To Location in the shipment.

 <Receiver><Identifier>

Tips

  • Select the name of the report file to export the report file generated for the Tatmeen system.
  • Select the name of the response file to export the response file received from the Tatmeen system.
  • Select the name of the message status query file to export the request sent to the Tatmeen system to get the processing results of the report submitted.
  • Select the name of the message status response file to export the response file received from the Tatmeen system for the message status query.
Field Description Sourced From Tatmeen Report Element
Delivery Number The delivery number associated with the shipment. The Delivery Number for the shipment in Serialized Operations Manager.

Not reported
Date Shipped The date that the delivery was shipped. The Shipment Date for the delivery in Serialized Operations Manager.

Not reported
To Business The address and SGLN of the business that the delivery is shipped to. The To Business for the shipment in Serialized Operation Manager. destinationList
From Business The address and SGLN of the business that shipped the product. The From Business for the shipment in Serialized Operation Manager. sourceList
Ship To Location The address and SGLN of the location that the delivery is shipped to.

The Ship To Location for the shipment in Serialized Operation Manager.

 destinationList
Read Point The SGLN (in GLN format) of the Pharmaceutical Manufacturer. The SGLN (in GLN format) of the Pharmaceutical Manufacturer. readPoint
Event Time The shipment event date and time. The shipment event date and time. eventTime
Transaction ID An identifier that denotes whether the product is imported in UAE or manufactured in UAE. Always populated with Import Permit or Sales Permit. bizTransaction
Disposition The status that results from the event. Displays as In transit. Always populated with in transit. disposition
Business Step The step within the business process at the time of the event. Displays as Shipping. Always populated with Shipping. bizStep
Action The action being taken at the time of the event. Displays as Observe. Always populated with Observe. action

Tips

  • Select Export Serial Numbers to export the serial numbers in the report to a CSV file.
Field Description Sourced From Tatmeen Report Element
Packaging Code The packaging code for the product. The Packaging Code of the serialized item in the shipment. gtin
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. itemExpirationDate
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 numbers 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.
  • Event Time – The shipment event date and time.
  • Action – The action being taken at the time of the event. Displays as Add.
  • Business Step – The step within the business process at the time of the event. Displays as Commissioning.
  • Disposition – The status that results from the event. Displays as Active.
  • EPC Format – The parent serial number in EPC format.
  • Read Point – The GLN value of the Pharmaceutical Manufacturer in the SGLN format.
  • Business Location – The GLN value of the Pharmaceutical Manufacturer in the SGLN format.

    The Business Location and Read Location always have the same values. The UAE government requires Owners to report both fields.

Tips

  • 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).
    • Child Quantity – The number of child serial numbers aggregated to the Parent Serial Number.

    Tips:

    • The parent serial number also displays in the screen title.
    • Select Export Child Serial Numbers to export the child serial numbers aggregated to the Parent Serial Number as a CSV file.

    Child Serial Numbers

    • Serial Number – The child serial numbers aggregated to the Parent Serial Number.
    • EPC Format – The child serial number in EPC format.
    • 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.
    • Event Time – The child shipment event date and time.
    • 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.
    • Expiration Date – The expiration date associated with the Lot Number. Displays a value only if the serial number has a Packaging Level of Each.
    • Read Point – The GLN value of the Pharmaceutical Manufacturer in the SGLN format.
    • Business Location – The GLN value of the Pharmaceutical Manufacturer in the SGLN format.

      The Business Location and Read Location always have the same values. The UAE government requires Owners to report both fields.

Response information when using the message status query service:

  • Response Date – The date the response is received from the Tatmeen system.
  • File Name – The name of the file received from the Tatmeen system.
  • Response Type – The type of response returned by the Tatmeen system. For every compliance report submitted, there are two response types:
    • Response for the compliance report submitted to the Tatmeen system.
    • Response for the compliance report returned by the Tatmeen system for the report status query sent by MAH.
  • Status – The status returned by the Tatmeen system for the submitted compliance report.
  • Status Code – The response code returned by the Tatmeen system for the submitted compliance report.
  • Message Code – The message code returned by the Tatmeen system for the submitted compliance report.
  • Description – The description returned by the Tatmeen system for the submitted compliance report.