Partner-Specific Mailbox Profile Workflow

At a high-level, the profile has the following flow:

  1. A Provider receives an 835 Claim Payment transaction batch.
  2. The corresponding route splits the transaction based on unique Provider IDs.
  3. The route component TPM Lookup performs a lookup in the Trading Partner Management system using the ProviderID and returns specific ProviderParameters:
    • Transport: the type of outbound endpoint to be used for the particular Partner.
    • MailBox: the destination location to send a Partner's data to. Depending on the transport type used, this setting holds the corresponding destination, for example a queue name for JMS, an email box for email, a folder name for file system, or anything else like a FTP folder name, and other.
    • Usage Indicator: This marker defines whether the data is intended for test or production use. This information is contained in the transaction's ISA.15 element on the interchange envelope level.

    This profile uses a custom mock implementation (a subroute that extracts data from a Provider-bound XML file) to emulate a Transaction Management (TM) system. However, this profile can use real TPM Lookup components to retrieve information about a particular provider from Transaction Management. For more information on how to use the route component TPM Lookup, see Configure TPM Lookup section in the Transaction Management Implementation Guide. The route component TPM Lookup becomes available in XEServer after Transaction Management is installed.

  4. Then, for every individual transaction, the Receiver Identification segment is updated with the qualifiers REF.01=EV (Receiver Identification Number) and REF.02=${MailBox}. Also the transaction's Interchange Usage Indicator (ISA.15) is updated based on the Trading Partner settings.

  5. Finally, the 835 Claim Payment document is directed to the required destination defined by the Partner-specific Transport and MailBox values.

This profile is extendable and can be adjusted to your business needs. Here are a few options on how to do this:

  • Transaction Management users can use the TPM Lookup component to extract Trading Partner settings.
  • For a custom TPM system implementation there can be any proprietary mechanism that extracts Trading Partner settings.

On this route, an incoming 835 Claim Payment transaction is split into individual Provider transactions and an emulated Transaction Management system extracts the required information on the Provider. Then, an 835 Claim Payment transaction is created with corresponding updated segments, and finally directed to the required destination.

Route Structure

Redirecting Messages to MailBox Route

Route Components Description

Component Name Component Type Description
835 Intake FS Inbound Picks up an 835 Claim Payment transaction from the file system.
Split by PayeeID XE Native Splits the transaction by unique Provider IDs. During splitting, the component extracts Provider ID (transaction's Payee ID field) and attaches it to every individual transaction in the form of an XEServer property ProviderID.
TPM Lookup Subroute

Emulates the Trading Partner Management system by invoking the TPM Lookup route. The component receives an individual transaction along with an XEServer property Provider ID and returns the same transaction with the following three XEServer properties attached to it:

  • Transport: Indicates the type of transport to be used by the component.
  • MailBox: Indicates the name of the destination (either JMS queue or email box folder) for the current Provider.
  • UsageIndicator: Indicates whether the transaction is a Testing or Production version.

 
Validation Reports FS Outbound Stores validation reports in the file system.
835 Update XE Translator

Converts the received individual transactions into a 835 Claim Payment transactions with several updates:

  1. If the XEServer property MailBox exists ( which means that a Provider was found in the TM / emulated system), a new REF segment with qualifier REF.01 = "EV" and REF.02 = ${MailBoxValue} is added.

    Example

    ...

    REF*EV*Richter835queue

    ...

  2. Depending on the value of UsageIndicator received from the TM/emulated system, the Usage Indicator segment is modified in the ISA envelope.

The component converts the transactions into new 835 Claim Payment transactions using the map file 5010_835-835updates that is available.
Transport Selection Router Selects a matching destination for every partner-specific transaction by checking the XEServer property Transport.
Translation Reports FS Outbound Stores the validation reports in the file system.
Default FS Outbound Stores transactions for partners that could not be located in the TM / emulation system.
FS Mailbox FS Outbound Stores the partner-specific transactions that should be sent by email.
JMS Mailbox FS Outbound Stores the partner-specific transactions that should be sent through the Java Message Service.

This route emulates the Trading Partner Management system. If you are using Transaction Management, this route can be replaced by the route component TPM Lookup.

The route receives individual 835 Claim Payment transactions and for every transaction, picks up a suitable XML file from the file system based on the XEServer property ProviderID. The matching XML file contains detailed information about the required Provider. Then, ProviderParameters are extracted from the XML file, and the individual 835 Claim Payment transaction along with ProviderParameters is sent back to the route Redirecting Messages to MailBox.

Route Structure

TPM Lookup Route

Route Components Description

Component Name Component Type Description
In Parent Route Input Receives an individual 835 Claim Payment transaction from the route Redirecting Messages to MailBox.
Partner Selector Router Checks the XEServer property ProviderID, and depending on the value, sets a new XEServer property TemplateFileName and directs the transaction for further processing.
Provider Cibil Mock Velocity

Dynamically selects an XML file based on the XEServer property TemplateFileName and sends this XML file further down the route for processing. For every transaction, the XML file is picked up from the following location: ${XESProfileConfig}/configuration/template/{Prp[TemplateFileName]}.

Extracts XML fields XML Value Extractor

Extracts the following ProviderParameters from the provider-specific XML file using XPath:

  • MailBox
  • Transport
  • UsageIndicator

Sets these values as XEServer properties and directs the data for further processing.
Aggregation Aggregation

Adds XEServer property ProviderParameters to the original individual 835 Claim Payment transaction.
Out Parent Route Output Sends the individual transactions with the XEServer property ProviderParameters back to the route Redirecting Messages to MailBox.