ESP evaluator
The ESP Evaluator time-triggered transaction verifies whether a shipment meets certain economic shipping parameters (ESP). ESP can be configured either for buyer or enterprise, with the freight terms on the shipment determining which one is used.
If the configuration is defined to hold shipment for ESP, the shipment when created is held for ESP (with status On ESP Hold). This task queue based time-triggered transaction evaluates the shipment for ESP, and passes it on to the next step in the shipment pipeline if the criteria (weight and volume limits, plus maximum days of hold up) are met. The shipment status is now set to Released from ESP hold, and routing processing begins.
Attributes
The following are the attributes for this time-triggered transaction:
| Attribute | Value |
|---|---|
| Base Transaction ID | ESP_EVALUATOR.0001 |
| Base Document Type | Order |
| Base Process Type | Outbound Shipment |
| Abstract Transaction | No |
| APIs Called | None |
| User Exits Called | getNodeMinimumNotificationTime |
Criteria parameters
The following are the criteria parameters for this transaction:
| Parameter | Description |
|---|---|
| Action | Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value. |
| EnterpriseCode | Optional. Enterprise for which the ESP Evaluator needs to be run. If not passed, then all enterprises are monitored. |
| Number of Records to Buffer | Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000. |
| Next Task Queue Interval | Optional. Specifies in hours how long a failed task should be suspended before it is considered for reprocessing. Defaults to 5 hours. |
| Task Queue Filter Criteria | Optional. Determines the jobs to be retrieved by the agent. The value that is assigned to
this parameter is matched against the custom value that is stored in the
FILTER_CRITERIA column of YFS_TASK_Q table while retrieving the
jobs. Note:
VOID is a valid task queue filter criteria value that is used to match
records with NULL value in the FILTER_CRITERIA column of
YFS_TASK_Q table.For more information, see Workload segregation for task queue agents. |
| Node | Required. The ship node for which records are being processed. |
| AgentCriteriaGroup | Optional. Used to classify nodes. This value can be accepted by Sterling™ Order Management System time-triggered
transactions that only perform their tasks on the nodes with a matching node transactional velocity
value. Valid values are: LOW, HIGH, and any additional values defined by the Hub from Application Platform > System Administration > Agent Criteria Groups. |
| ColonyID | Required in a multischema deployment where a table may exist in multiple schemas. Runs the agent for the colony. |
Statistics tracked
None.
Pending job count
For this transaction the pending job count is the number of records available to be processed by the transaction with the AVAILABLE_DATE value less than or equal to (<=) the current date value in the YFS_Task_Q table.
Events raised
The following events are raised by this time-triggered transaction:
| Transaction/Event | Key Data | Data Published | Template Support? |
|---|---|---|---|
| ON_SUCCESS | shipment_dbd.txt | ESP_EVALUATOR.ON_
SUCCESS.xml |
Yes |