Introduction to DataWeave in Salesforce Apex

MuleSoft's DataWeave, is a powerful data transformation language used in MuleSoft applications to transform, query, and format data. It enables developers to manipulate data seamlessly across different formats such as JSON, XML, CSV, Java objects, and more. DataWeave's versatility is what makes it the go-to tool for data transformation in real-world integration projects.

In this blog, we'll explore the features of DataWeave, its real-world applications, and provide code snippets to illustrate how it simplifies complex data transformations.

Key Features of DataWeave

Language Flexibility: DataWeave supports multiple data formats, such as JSON, XML, CSV, Java, and others.
Simple Syntax: The language is designed to be simple, concise, and easy to read, making data transformations straightforward.
Transformation Capabilities: It enables both simple and complex transformations like mapping, filtering, grouping, and aggregating data.
Built-In Functions: DataWeave comes with a rich set of built-in functions that allow for complex operations such as string manipulations, mathematical calculations, and date transformations.

Real-World Examples of DataWeave Usage

JSON to XML Transformation
In a typical e-commerce integration, you may need to transform a JSON payload (received from a REST API) into XML format (required by a backend system). Below is an example of how DataWeave can easily handle this transformation.
Input (JSON):
json

                               
{
  "orderId": "12345",
  "customer": {
    "name": "John Doe",
    "email": "john@example.com"
  },
  "items": [
    {
      "product": "Laptop",
      "quantity": 1,
      "price": 1200
    },
    {
      "product": "Mouse",
      "quantity": 2,
      "price": 25
    }
  ]
}

Transformation (DataWeave Script):

                               
%dw 2.0
output application/xml
---
order: {
    id: payload.orderId,
    customer: {
        name: payload.customer.name,
        email: payload.customer.email
    },
    items: payload.items map ((item, index) -> {
        itemNumber: index + 1,
        product: item.product,
        quantity: item.quantity,
        price: item.price
    })
}

Output (XML):

xml

coding

DataWeave

Figure 1: DataWeave can map JSON fields to an XML structure and apply transformations.

This simple script demonstrates how DataWeave can map JSON fields to an XML structure and apply transformations (like adding itemNumber dynamically).

Figure 1: Here, DataWeave converts a CSV dataset into JSON, while adding a transactionId field and converting itemNumber dynamically).

CSV to JSON Transformation
Consider a scenario where you need to convert CSV data from a financial system into a JSON format to be consumed by a web service.
Input (CSV):
csv

                               
Date,Amount,Description
2024-01-15,2000,Rent Payment
2024-01-20,1500,Utility Bill

Transformation (DataWeave Script):

                               
%dw 2.0
output application/json
---
payload map ((row, index) -> {
    transactionId: index + 1,
    date: row.Date as Date,
    amount: row.Amount as Number,
    description: row.Description
})

Output (JSON):

json

                               
[
  {
    "transactionId": 1,
    "date": "2024-01-15",
    "amount": 2000,
    "description": "Rent Payment"
  },
  {
    "transactionId": 2,
    "date": "2024-01-20",
    "amount": 1500,
    "description": "Utility Bill"
  }
]

DataWeave converts

Figure 2: DataWeave converts a CSV dataset into JSON.

Here, DataWeave converts a CSV dataset into JSON, while adding a transactionId field and converting Date and Amount fields to their appropriate types.

Filtering and Aggregating Data
In a logistics system, you might need to filter records and aggregate data for reporting purposes. For instance, filtering orders with a status of "completed" and then summing up the total revenue.
Input (JSON):
json

                               
{
  "orders": [
    { "id": 1, "status": "completed", "amount": 250 },
    { "id": 2, "status": "pending", "amount": 150 },
    { "id": 3, "status": "completed", "amount": 400 }
  ]
}

Transformation (DataWeave Script):

                               
%dw 2.0
output application/json
---
{
  "totalCompletedOrders": sizeOf(payload.orders filter ((order) -> order.status == "completed")),
}

Output (JSON):

json

                               
{
  "totalCompletedOrders": 2,
}

DataWeave filters

Figure 3: DataWeave filters orders based on their status.

In this example, DataWeave filters orders based on their status and computes the total number of completed orders and the total revenue from those orders. This is particularly useful for creating summary reports in real-time.

Why Use DataWeave in MuleSoft Projects?

Efficiency: DataWeave allows for powerful transformations with minimal code, reducing the complexity of integration tasks.
Versatility: It can handle data from various sources and in multiple formats, making it indispensable for cross-system integrations.
Customization: With its ability to use functions, filters, and transformations, DataWeave is highly customizable to fit different business needs.

Conclusion

DataWeave is a vital tool for developers working with MuleSoft, offering robust features for data transformation. Whether you're working with JSON, XML, CSV, or custom data formats, DataWeave simplifies complex tasks, saving time and improving the overall efficiency of your Mule applications. Try incorporating DataWeave in your next project to see the difference it makes in handling data transformations. By mastering DataWeave, you unlock the full potential of MuleSoft and streamline data management across systems.

MuleSoft itself plays a critical role in connecting enterprise systems, APIs, and applications through modern integration architecture. To explore more MuleSoft capabilities, integration patterns, and related development resources, visit our MuleSoft page.

For any queries please reach out to support@astreait.com

Getting Started with DataWeave for Salesforce Developers