Skip to main content
Feedback

Integration Hub listener process building

Integration Hub listener processes perform data validation and/or enrichment on incoming batches of source entities.

A Integration process call data quality step in a model specifies a Hub listener process that is or will be deployed to the Boomi Hub Cloud that hosts the repository to which the model is deployed. When, during processing of a batch, the data quality step is applied, the specified process executes.

Hub listener processes are so named because they utilize the Boomi Master Data Hub Listener connector.

All steps and components are available for use in building listener processes. If you are new to building processes, refer to the Integration documentation. For the remainder of this topic, it is assumed you have rudimentary knowledge of process development.

note

To use a listener process that sends validation or enrichment requests to another Internet-based service or an application behind your firewall, you must configure the destination to accept requests from the Hub Cloud on which the repository is hosted. maintains regional Hub Clouds worldwide.

Start step

A Hub listener process Start step must be configured as a Boomi Master Data Hub Listener connector operation. There is not a connection component as the Boomi Master Data Hub Listener connector is listen-only. The operation does not have any configuration options. The operation’s purpose is simply to receive the batch of source entities.

Input documents

XML is the native format of batches of source entities. In a Hub listener process, each source entity in the incoming batch is an input document whose format is specified in an XML profile. Typically you will reuse the profile automatically created for Boomi Data Hub connector operations.

Output documents

In a Hub listener process, each source entity is an output document whose format is specified in an XML profile. Here again you typically will reuse the profile automatically created for Boomi Data Hub connector operations.

Terminate the process with a Return Documents step to enable return of the batch to Boomi Data Hub for continuation of processing. Any entities that were enriched during the process execution are returned in their enriched state. If a field is not present in a returned entity — that is, there are no XML tags for the field — the original value of that field from the contributed entity is used as the field value for the continuation of processing of the entity. If a field in a returned entity is represented by an empty element, null is used as the field value for the continuation of processing of the entity.

Validation

Validation processing in a Hub listener process occurs in two phases:

  1. Batch-level validation (optional)

    The process determines whether the batch contains entities requiring validation and routes processing accordingly. You can use a Route step to perform validation based on batch metadata. Batch metadata is received as dynamic process properties by the Boomi Master Data Hub Listener connector operation in the Start step as follows:

    • mdm_source_id — ID of the batch’s contributing source.

    • mdm_account_id — ID of the account that contributed the batch.

    • mdm_repository_id — system ID of the repository that hosts the target domain.

    • mdm_universe_id — system ID of the domain.

  2. Entity validation

    The process distinguishes between valid and invalid entities and routes processing accordingly. For each entity, the source entity ID is received as the dynamic document property mdm_source_entity_id by the Boomi Master Data Hub Listener connector operation in the Start step. Each root entity element’s id attribute is populated with the Batch Entity ID, which is accessible from the batch detail view in the Inbound Activity page (Reporting > Inbound Activity).

    If an entity is an update to an existing golden record, the golden record’s ID is received as the dynamic document property mdm_record_id by the Boomi Master Data Hub Listener connector operation in the Start step. In addition, the root entity element’s grid attribute is populated with the golden record’s ID.

    • You can use a Route step to perform validation based on entity metadata or field value.

    • If you need to perform validation by means of a look-up in an external data source, such as a database, you can use connector operations in conjunction with a Decision step.

    Terminate the execution path for invalid entities with an Exception step to enable the entities to be quarantined upon continuation of batch processing in Boomi Data Hub. You can specify the reason for quarantining that will be returned to Boomi Data Hub by populating the Message field in the Exception Properties dialog. In that dialog, select Stop Single Document; otherwise, all entities will be quarantined.

Enrichment

Enrichment processing in a Hub listener process augments and/or replaces entity data.

  • You can satisfy most requirements for enriching entity data using a Map step referencing a map component whose input and output XML profiles are the same. In the map you can use map functions to transform each entity in its contributed state to an enriched state. To use an external data source as the source of enriched data, you can use a map function with a connector call to connect to that data source. You can enrich unpopulated entity fields with static values by setting default field values in the output profile.

  • You can satisfy more complex requirements using custom scripting in map functions or Data Process steps.

note

Splitting and combining entities using Data Process steps may yield unpredictable results and is not recommended.

Example process

Here is an example of a Integration Hub listener process that performs both validation and enrichment on an incoming batch of source contact entities:

Example of a listener process

As is always the case for a Hub listener process, the Start step’s Boomi Master Data Hub Listener connector operation and the Return Documents step serve as the process’ bookends. Neither requires configuration.

The Route step in this example performs validation on an entity based on the value of the entity’s country field, as noted in the step label. An entity whose country is “United States” is considered valid.

  • A valid entity is routed to the Map step for enrichment. As noted in the step label, the referenced map performs enrichment on specified fields in the entity by means of a map function that connects with a database, which serves as the source of enriched data.

  • An invalid entity is routed on the default execution path to the Exception step. The entity will be quarantined upon continuation of batch processing in Boomi Data Hub. The reason for quarantining is constructed in the Exception Properties dialog, as noted in the step label.

note

This process does not perform batch-level validation.

On this Page