In PackageBee, a Task is a single operation in the processing of an order. Importing, reprocessing, and archiving an order are examples of individual Tasks that can fail or succeed.
A Violation is the record of a failed Task.
You can view and search for Violations at app.packagebee.com/violations.
Violations and Incidents
Every Violation belongs to an Incident. An Incident is a group of Violations.
An Incident can either be open (it contains unresolved Violations) or closed (all of its Violations are resolved).
Incident Alert Notifications
If you have configured a Notification Channel and Alert Policy, you receive two Notification emails about an active Incident: one when the Incident opens, and one when it is closed.
Add a Notification Channel in PackageBee.
Types of Violations
There are three types of Violations: Store, Warehouse, and Order Violations.
- Store - Errors connecting or communicating with the Store API.
Example: when PackageBee attempted to import an order from Store API, the import failed due to invalid or unexpected data.
- Warehouse - Errors connecting or communicating with the Warehouse API.
Example: when PackageBee attempted to import shipment data from the WMS, the import failed due to invalid data in the shipment file.
- Order - Errors with the order itself.
Examples: required fields in the order are blank; data for an order field exceeds its maximum length; SKUs listed in the order are invalid.
Lifecycle of a Violation
- When a Task fails, it is recorded as a Violation in PackageBee.
- If the new Violation belongs to an open Incident (that has other unresolved Violations), it is added to that Incident. No Notification is sent.
- If the new Violation opens an Incident (it is the only unresolved Violation in that Incident scope), an Alert Notification is sent.
- PackageBee attempts multiple times to resolve the Violation by retrying the Task.
- If the Task succeeds, the Violation is resolved. If there are no other unresolved Violations for that Incident, the Incident is closed, and a Notification is sent.
- If the Task continues to fail, the Incident remains open.
How can I find more info about a Violation?
A Violation contains the fundamental data about a Task failure.
For example, an Order Violation contains the following records:
- Opened - Time when the Task first failed.
- Closed - Time when the Task eventually succeeded.
- Duration - How long the Task was in a failed state.
- Severity - Indicates the severity of the failure, e.g.,
Error. - Details - Indicates the source of the failure, e.g.,
Order ID. - Impacted - Quantity and ID of orders affected by the failure.
- Message - The error message, e.g.,
Shipping city can't be blank.
However, Store and Warehouse Violations don't link to specific orders. Instead, they link directly to the Store or Warehouse.
If you want to find order-specific information about these Violations, you can search and filter your Orders for errors.
Search and filter Orders for Errors
Note: If a Violation doesn't provide the information you need, follow these steps to search your Orders and filter them for errors.
- In your PackageBee Dashboard, click Orders.
- Click inside the Search field.
- In the Fulfillment Status menu, select Error.
- Select any additional filters to narrow your search if desired, then click the Search icon. ( 🔍 )
- To view more information about an error, click the Order number in the search results.
Error information is displayed in red at the top of the Order.
How can I receive fewer Alert Notifications?
In your Alert Policy settings, you can choose the scope of Notifications by setting the Incident Preference. This setting defines how many Violations are grouped into a single Incident (and therefore how many Notifications are sent).
Incident Preference options:
- Per policy - Incidents are created at the Policy level. For each Policy you have, all Violations in that Policy are grouped as a single Incident. You receive the fewest Notifications with this setting.
- Per condition - Incidents are created at the Condition level. For each Condition defined in your Policy, all Violations of that Condition are grouped as a single Incident. You receive more Notifications with this setting.
- Per condition and target - Every Violation is classified as its own Incident. You receive the maximum Notifications with this setting.
Comments
Please sign in to leave a comment.