Invoking a Service when an Email is received


This tutorial explains how you can invoke a Petals service when an email is received.
The email content is injected in a JBI exchange (i.e. a Petals message) and sent to the invoked service.
This is why, for the current versions of the Petals Mail component, the email content must be a XML document.

Technically, this tutorial shows the creation of a service-unit for the Petals-BC-Mail component in consumes mode.

Level: Easy
Estimated time: 10 minutes the first time, 3 minutes then
Expected skills: -

Creating the Service-Unit project

Getting started

Start Petals Studio.
In the menu, select File > New > Petals Service Consumer.
If you do not see it, go into File > New > Other... Then, select Petals Service Consumer under the Petals category.

A wizard opens, showing three drop-down lists.
In the Use Case list, select Communication.
In the Petals Component list, select Mail // petals-bc-mail.
In the Component Version list, select the version of the Petals-BC-Mail that you are using in Petals.

In the scope of this tutorial, we are going to work with the version 3.2 of the Mail component.
Which gives us:

Click Next.

Identifying the target service

The current page requires you to fill-in the base information to put in the JBI descriptor (META-INF/jbi.xml).
In particular, it defines the interface, service and end-point names of the service that will be invoked when a file is added in the watched directory.

A service is identified by a triplet, interface, service and end-point names. This triplet is unique in a Petals topology.
When you consume a service, the service is selected in a set. This set is defined by the invocation properties.

If the 3 fields are set in the consume properties, then the set will contain at most 1 result (there can be only 1 service with this ID).
If 2 fields are set, then the third one is considered as a wildcard and the set will larger.

Consume possibilities are the following ones:

  • By interface, service and end-point names.
  • By interface and service names.
  • By interface name only.

This page also defines the operation to invoke and the Message Exchange Pattern (MEP).
The Message Exchange Pattern (MEP) defines the interactions between the Mail component and the invoked service.
With this component, only operations that work with the InOnly MEP can be invoked.

You can obviously fill-in these fields by hand.
However, the most efficient way is to use the Petals Services explorer (provided it was populated).
Click Select a service. A selection dialog shows up, providing filtering assistance.

When you have selected your service, click OK.
The wizard fields are filled-in automatically.

The values for the interface, service and end-point names must match the values defined in the jbi.xml of the invoked service.
Indeed, this service must be a Petals service, and thus be described in a jbi.xml.
As a reminder, the jbi.xml values and the WSDL values (if the WSDL exists) of the invoked service must be exactly the same.

For this reason, filling-in the information by hand or modifying it is discouraged.

Click Next.

Defining the project name

This page defines the name and the location of the project that will be created.
Indeed, this wizard will result in the creation of a project containing all the required elements for a Mail service-unit.

Enter a project name for your project.
If you do not want your project to be created in the default workspace, uncheck Use default location.
Then click Browse... and select the location where the project will be created.

Petals service-units have a naming convention.
For a service-unit which consumes (calls) a service, the convention is su-<Protocol or Technology>-<Service name>-consume

Then, click Next.

Specifying the Mail parameters

This page defines information which are specific to the Petals Mail component.
Most of these parameters are transparent for the user.

The meaning of all the parameters can be read in the documentation of the Petals-BC-Mail component.

Click Finish to complete the wizard.

Checking the result

When the wizard has completed, a new project has been created and is visible in your workspace.

It contains a jbi.xml file, located under src/main/jbi.
This hierarchy allows you to work with Apache Maven then (a pom.xml was also created at the root of the project).
There is nothing else in the project.

Updating, packaging and deploying

Further edition and packaging

After completion, the newly created jbi.xml file has been open in the Service-Unit editor.
Regarding Mail configurations, the wizards are complete.

The project contains everything the Mail component needs.
You can now package it before deploying it.

The created project being a Service-Unit project, you can package it as any Service-Unit project.
It results in the creation of a Service Assembly for the Petals-BC-Mail component. Its location depends on your export choices.


The deployment of the created service assembly can be achieved with the Petals web console.
Or you can do it by dropping the service assembly in the install directory of your Petals installation.
This second option should only be used in development steps.

First, make sure the Petals-BC-Mail is installed in your Petals environment.
Then, install the service assembly in your Petals, using one of the two ways indicated above.

There is no need to update configuration of the Mail component to make it work.
Using the default settings is enough to make the service-unit work.


petals petals Delete
tutorial tutorial Delete
bc bc Delete
mail mail Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.