Contact Free trial Login

Parse Template Reference

Parse Template is the Mule component to use for processing a template and obtaining a result. A template is defined as text with embedded Mule expressions that are evaluated and replaced with their result.

You can configure template through an external file reference, or you can embed it in the component definition itself.

Configuring a Parse Template

  1. In Studio, drag a Parse Template message processor from the palette onto the canvas.

  2. Configure the fields described in this table:

    Field Value Description


    Template String

    A string to use as a template. Instead of defining the template in an external file, you can use this field to write it inline. It can contain embedded expressions to be evaluated and replaced with their results.

    Display Name

    Parse Template

    Customize to display a unique name for the transformer in your application.



    Define the location of the file that Mule uses as a template into which to insert values extracted from the message properties or variables.

    Target Variable

    Variable Name

    The name of a variable that stores the result of evaluating the expression defined in Target Value.

    Target Value


    Mule Expression to be evaluated after executing Parse Template. The result of this expression is stored in a variable with the name defined in the Target Variable field.

If you are using the XML editor in Studio or a Standalone Mule instance:

  • Add a parse-template element to your flow, then configure it according to the tables below.

    <parse-template location="users/administrator/desktop/hrweb/confirmation.html" doc:name="Parse Template"/>

Attributes of the parse-template element:

Element Attributes Value


A string representing the template to be used where the embedded expressions will be evaluated and replaced by their results.


Filepath which defines the location of the file that Mule uses as a template into which to insert values extracted from the message properties or variables.


Customize to display a unique name for the transformer in your application. (Note: Not needed in Mule standalone.)


The name of a variable where the result of the expression defined in targetValue will be stored after the Parse Template is executed.


A Mule Expression that will be evaluated after the Parse Template is executed and which result will be stored in a variable with name as defined in the target attribute.

Code Example

The following example demonstrates the use of a Parse Template in an application that accepts queries by employeeID to acquire data about an employee.

In this case, Parse Template uses a file external to the flow as a template into which it inserts values for fields (name, department, job title, start date, and employee type) drawn from the message payload. The flow then returns the template-built payload to the caller.

parse template flow
			<th>First Name</th>
			<th>Last Name</th>
			<th>Job Title</th>
			<th>Start Date</th>
			<th>Employee Type</th>


<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="" xmlns:http=""
      xmlns="" xmlns:doc="" xmlns:xsi="" xsi:schemaLocation="">
    <db:config name="Database_Config" doc:name="Database Config" doc:id="e4df87d8-ec1e-49ec-a528-43e93baa5bda" >
        <db:my-sql-connection host="localhost" port="3306" user="user" password="pw" database="MySQL_Data_Source" />
    <http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="724690b1-cc2f-451a-86eb-66f7750feba1">
        <http:listener-connection host="localhost" port="8081" />
    <flow name="exampleTemplateFlow1" doc:id="b8cc9464-5991-4977-978f-9f51eb252ec8" >
        <http:listener doc:name="Listener" doc:id="f334ba27-ae1f-4da5-a194-26e57a1aa637" config-ref="HTTP_Listener_config" path="/getEmployee"/>
        <db:select doc:name="Select" doc:id="c3ab7830-9920-4637-9329-954a8a94e54c" config-ref="Database_Config">
            <ee:repeatable-file-store-iterable />
            <db:sql >SELECT * FROM Employees WHERE id=#[attributes.queryParams['id']]</db:sql>
        <parse-template doc:name="Parse Template" doc:id="53211517-f943-40b2-86e3-20a0e1ca4eb6" location="src/main/resources/responseHtml.template"/>

To use the application in this example, you must send an HTTP request with a URL that includes an ID query parameter, such as http://localhost:8081/getEmployee?id=12345.

Special Characters

Parse Template supports the use of nested expression and literals inside expressions. There are some characters for special uses:

  • An expression, which begins with the sequence #[, contains nested expressions. Inside an expression, the character [ defines the start of an expression. The character [ does not need a preceding # . The character [ is treated as a special character inside an expression.

  • Inside an expression, single quotes are used both to quote text and to treat text as a literal. So, the expression #['['] is a valid expression that evaluates to [. Outside expressions, single quotes are used as literals.

  • To avoid using a single quote to quote text inside an expression, add a backslash to escape it. For example #['this isn\'t an expression'].

  • Outside an expression, it is not necessary to quote characters # and [ unless they are together. For example to create an expression just write \#[ the-expression-to-resolve ].

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub