Lab 2: Implement the customer creation logic


In the previous lab, we created the project skeleton from the Customer API. Now it’s time to implement it. The Customer API contains all the operations for managing customer data - create (POST), read (GET) , update (PUT) and delete (DELETE). For the purposes of this lab, we will only implement the customer creation represented by the POST method.

The customer creation logic is as follows:

  1. Create the Account in SDFC to represent the customer

  2. Validate the successful creation of the account

  3. If validation fails,

    1. Raise an error mapped to Bad Request (400 is the status code for Bad Requests)

  4. If successful,

    1. Get Account Details

    2. Convert Response to JSON

Step 1: Add Salesforce Connector to the Project

The steps that need to be executed are:

  1. With the api view selected, click the Add Module module3_lab2_add_module_symbol sign in the Mule Palette view in order to add the Salesforce Connector and Validation module required for our implementation in the next step.

    module3 lab2 project add modules
  2. Drag and Drop Salesforce Connector and Validation Module.

    module3 lab2 studio add modules finish

    Notice that we’re leveraging the mule lightweight module-based framework to support our use case. The Salesforce Connector provides connectivity to Salesforce and the Validation Module is a component to implement validations, similar to the concept of an assertion, for validation checks like boolean expressions, null values, specific values, and other conditions. Subsequently, the flow execution can generate out of the box and custom Error Types to the Error handling scopes within your flow.

    At the end, the palette should look similar to the following image.

    module3 lab2 palette
  3. Now, you are ready to implement the POST resource operation. Find the post:\customer:application\json:api-config resource flow (at the bottom of the api view)

    module3 lab2 find flow post
  4. Delete the generated Transform Message step that returned the sample response from the API specification

  5. From the Mule Palette, select Salesforce​, scroll to Create and drag and drop the component to the flow.

    module3 lab2 sfdc drag
  6. Click on Salesforce icon and the configuration will be shown below.

  7. Change its name to Create Account

    module3 lab2 change sfdc create account name
  8. Click the module3_lab2_save_all_button Save All button.

Step 2: Create a Property File

It’s a good practice to create a configuration file to hold all the parametrized properties in the project. We are going to create one and configure the connection credentials for our API implementation. First, we are going to create a folder and then create the config file.

  1. Click on src/main/resources in the Package Explorer view, right click and create a New → Folder, name it configuration and click Finish

    module3 lab2 configuration folder create
  2. Click on src/main/resources/configuration in the Package Explorer view, right click and create a New → File, name it config.yaml and click Finish.

    module3 lab2 properties create 1
    module3 lab2 properties create 2
  3. Copy the following contents into config.yaml. These are the connection credentials your API will use for the Salesforce connector.

      username: ""
      password: "Elum1379"
      securityToken: "7ZDtkYMazEtbvgdaaPrtMGit"
    module3 lab2 sfdc properties
  4. To finish the configuration of the properties file for your API, click on the api view and click on the Global Elements tab.

    module3 lab2 properties create 3
  5. Click Create, search for properties, select Configuration Properties, click OK. enter config.yaml in the File: attribute and click OK.

    module3 lab2 properties create 4
    module3 lab2 properties create 5
  6. Click the module3_lab2_save_all_button Save All button.

Step 3: Configure Salesforce Connector

  1. Now that you have your properties defined, let’s configure a new connector configuration. Go back to the Message Flow tab where you previously dropped the Salesforce connector and select it.

    module3 lab2 message flow
  2. Click on module3_lab1_plus_button button on the Connector Configuration.

    module3 lab2 salesforce connector configuration
  3. For the connector configuration we are going to put the following properties:

    • username: ${sfdc.username}

    • password: ${sfdc.password}

    • securityToken: ${sfdc.securityToken}

  4. Press Test Connection…​ to check everything is in place.

    module3 lab2 sfdc validate
  5. Press OK (2 times).

  6. Click the module3_lab2_save_all_button Save All button.

Step 4: Create an Account

Let’s configure the Salesforce connector to create an Account. We continue in the Salesforce Panel.

  1. Adjacent to the Type: property click the module3_lab2_sfdc_type_refresh_button refresh button, then select Account.

  2. Remove payload word in the Record box and press Refresh Metadata.

    module3 lab2 sfdc create single

    Now that we have configured the Salesforce connector, we need to create a mapping that will convert the JSON message from the Request to the Account Object that is going to be saved in Salesforce.

  3. Inside the Salesforce connector panel, in the Records section, press on module3_lab2_dw_icon.

    module3 lab2 dw sfdc
  4. You will see a Dataweave transformation, look at the input and output panels. You can drag and drop each field from the request (input) to the Salesforce object (output).

    In this mapping you will also use a function, uuid(), to generate a unique AccountNumber.

    module3 lab2 sfdc create dw complete

    This is the mapping code that the picture reflects. You can copy and paste it into your Dataweave text editor and the UI will reflect the changes

    %dw 2.0
    output application/java
    	BillingStreet: payload.billingAddress.address1,
    	BillingState: payload.billingAddress.state,
    	BillingPostalCode: payload.billingAddress.postalCode,
    	ShippingStreet: payload.shippingAddress.address1,
    	ShippingState: payload.shippingAddress.state,
    	ShippingPostalCode: payload.shippingAddress.postalCode,
    	AccountNumber: uuid(),

    Dataweave has a lot of useful functions that can be explore in Studio. Stand in the AccountNumber field and press F3 you can see all the functions that can be applied. Filter by uuid and you will find information about the function.

    module3 lab2 dw function tip

    Press Done when you finish the mapping.

    module3 lab2 sfdc create mapped
  5. Click the module3_lab2_save_all_button Save All button.

Step 5: Validate Salesforce Response

Once the Customer is saved, we need to evaluate the response from Salesforce (the request may fail if the information being sent is invalid).

  1. To do this, we are going to add a Validation: is true component. Type is true in the Mule Palette

  2. Drag and drop the icon at the end of the Flow.

    module3 lab2 validation in flow
  3. Implement the validation properties

    1. Display Name: Validate Response

    2. Expression: #[payload.successful == true]

    3. Message: Account Creation was Unsuccessful

      module3 lab2 validation config

      In the Validation component we are evaluating the Salesforce response.

  4. In the Validation, there are going to be two configuration changes, the Expression and the Message. Also, You will ensure that the out of the box error type is used to generate a validation error.

    1. Validate the response value

    2. If there was an error, we are going to respond with a Bad Request.

  5. Check the error mapping for the validation. Click the Error Mapping tab and click the module3_lab2_validation_error_mapping_plus_button button to view the out of the box error types, note the VALIDATION:INVALID_BOOLEAN is pre-populated so you don’t have to do anything else here.

    module3 lab2 validation error mapping

    In this case we are not going to map the error validation to a custom error. Instead, we are going to add the VALIDATION:INVALID_BOOLEAN to the APIKIT errors.

  6. Now, set the VALIDATION:INVALID_BOOLEAN in the APIKIT:BAD_REQUEST Error handler. Navigate towards the top of the api Message Flow view, locate the error handler, and select the Error Type.

  7. In the Type section add the following text ,VALIDATION:INVALID_BOOLEAN

    module3 lab2 validation bad request mapping

    Notice that mule provides an easy way to generate and capture out of the box, as well as, custom error types, to enable easy configuration of error handling scenarios.

  8. Click the module3_lab2_save_all_button Save All button.

Step 6: Build the Response

In this step we are going to get the created account and then we will build the response.

  1. Similar to the earlier step, drag and drop a Query component within the Salesforce connector to the end of the flow.

    module3 lab2 add query
  2. Configure the following properties:

    1. Display Name​: Get Account Detail

    2. Connector Configurator​: Salesforce_Config (we are reusing the configuration we created before).

    3. Salesforce query​: SELECT Id, AccountNumber, Name FROM Account where Id = ':id'

    4. Parameters​:

      1. Name: "id"

      2. Value: payload.items[0].id

        module3 lab2 sfdc query single
  3. Now you will create the transform step that will build the service response. To do that drag and drop a Transform Message after the Salesforce icon that was created in the previous step.

    module3 lab2 tranform connector create
  4. Right click on the Transform Message and select Rename. Change the Transform Message text with SFDC Account Detail to JSON.

    module3 lab2 rename transform icon
  5. Click on the icon and let’s see the transformation

    You will see the response from SFDC and the API Response.

    module3 lab2 sfdc response
  6. Copy and Paste the following dataweave script:

    %dw 2.0
    output application/json
    var customer = payload[0]
    	name: customer.Name default "",
    	id: customer.AccountNumber default ""
    module3 lab2 sfdc transf mapping

    If you look carefully, you will notice that

    1. The Response is an array. That’s why we are saving the first element is saved in a variable called customer.

    2. The Id and AccountNumber are defined as optional in the input. While in the output they are mandatory. That’s why you set a default value.

  7. Click the module3_lab2_save_button Save button.

This concludes the customer creation logic and we are ready to test the API.


In this lab, we

  • Implement the post flow

  • Configure the Salesforce connector

  • Retrieve Salesforce Account Object

  • Handle Salesforce Error

Go Further:

Congratulations! You have completed Lab 2.

Please proceed to Lab 3