EAKWSendIPSEvents

This document was generated using Claude.ai

Overview

Sends mail item status events to the International Postal System (IPS) for postal tracking integration. Processes mail items from entity detail collections and creates integration tasks to update postal tracking status in the external IPS system.

When This Action Runs

Manual execution for updating postal tracking status when mail items change location, status, or encounter delivery issues. Typically used in postal management systems for international mail tracking compliance.

How It Works

  1. Checks configuration - Verifies FRM module configuration allows IPS event sending
  2. Processes detail records - Iterates through specified detail collection containing mail items
  3. Validates mail items - Checks mail item IDs against allowed prefix filters
  4. Builds event data - Creates JSON payload with mail item details, office codes, and event information
  5. Looks up classifications - Finds mail class codes from delivery entries or postal sort lines
  6. Creates integration tasks - Saves IPS integration tasks for asynchronous processing
  7. Flushes changes - Ensures all integration tasks are committed to database

Parameters

Parameter 1: Office Code (Required) - Current postal office code handling the mail item

Parameter 2: Next Office Code (Optional) - Destination office code for forwarding

Parameter 3: Non Delivery Reason Code (Optional) - Code indicating reason for delivery failure

Parameter 4: Non Delivery Measure Code (Optional) - Code indicating corrective action taken

Parameter 5: Details Field ID (Required) - Field ID of the detail collection containing mail items

Parameter 6: Mail Item Field ID (Required) - Field ID within detail records containing mail item identifiers

Parameter 7: Event Code (Required) - IPS event code defining the type of status update

Database Tables Affected

  • IPSIntegrationTask - Creates new integration tasks for IPS communication
  • IPSEvent - Reads event configuration for JSON formatting
  • DLVDeliveryEntry - Looks up mail classification codes
  • IPSPostalParcelsSortLine - Alternative lookup for mail classification codes
  • FRMConfiguration - Reads module settings for IPS integration

Important Warnings

⚠️ Configuration Dependencies

  • Action is disabled if FRM configuration has "DoNotSendIPSDocumentsEventsToIPS" set to true
  • IPS user and workstation field IDs must be properly configured
  • Mail item prefix filtering requires proper configuration setup

⚠️ Mail Item Validation

  • Only processes mail items with non-empty identifiers
  • Mail items must match allowed prefix patterns if filtering is configured
  • Invalid or unrecognized mail item formats are skipped silently

⚠️ IPS Integration Requirements

  • Event code must exist in IPSEvent table with valid configuration
  • Integration tasks are created for asynchronous processing
  • External IPS system must be available to process tasks

⚠️ Data Field Requirements

  • Details field ID must reference a valid collection in the source entity
  • Mail item field ID must exist within the detail records
  • Field references are case-sensitive and must match entity structure

⚠️ Classification Code Lookup

  • System attempts to find mail class codes from delivery entries first
  • Falls back to postal parcels sort lines if delivery entry not found
  • Missing classification codes result in empty class code in IPS payload

⚠️ Performance Considerations

  • Processes all detail records in the specified collection
  • Each valid mail item creates a separate integration task
  • Large collections may generate many integration tasks requiring processing

⚠️ External System Integration

  • Integration tasks require separate processing system to send to IPS
  • Failed IPS communication may leave tasks in pending state
  • Monitor integration task processing for successful IPS updates

⚠️ Postal Code Validation

  • Office codes, reason codes, and measure codes should match IPS specifications
  • Invalid codes may cause IPS integration failures
  • Ensure codes conform to international postal standards

Module: frm

Full Class Name: com.namasoft.modules.frm.common.EAKWSendIPSEvents