Before you begin,
- Download the product installer from here, and run the installer.
Let's call the installation location of your product the <EI_HOME> directory. This is located in a place specific to your OS as shown below:
OS Home directory Mac OS
Select the relevant WSO2 Integration Studio based on your operating system and download it from here.
The path to this folder is referred to as
<EI_TOOLING>throughout this tutorial.
Getting an error message? See the troubleshooting tips given under Installing WSO2 Integration Studio.
- If you did not try the Storing and Forwarding Messages tutorial yet,
Let's get started!
Setting up the Message Broker profile
<EI_HOME>/conf/jndi and add the following line after
queue.MyQueue = example.MyQueue:
Creating the credentials for using the Gmail connector
Creating a Client ID and Client Secret
Follow the steps below if you want to use your own email address for sending emails.
- As the email sender, navigate to the https://console.developers.google.com/projectselector/apis/credentials URL and log in to your Google account.
If you do not already have a project, create a new project.
Click Google APIs -> Credentials -> Create Credential -> OAuth client ID.
At this point, if the consent screen name is not provided, you will be prompted to do so.
Select Web Application and create a client.
Provide https://developers.google.com/oauthplayground as the redirect URL under Authorized redirect URIs and click Create.
The client ID and client secret will then be displayed.
See Gmail API documentation for details on creating the Client ID and Client Secret.
Click Library on the side menu, and select Gmail API.
Obtaining the Access Token and Refresh Token
Follow these steps to automatically refresh the expired token when connecting to Google API:
- Navigate to the https://developers.google.com/oauthplayground URL, click at the top-right corner of the screen, and select Use your own OAuth credentials.
- Provide the client ID and client secret you previously created and click Close.
- Now under Step 1, select Gmail API v1 from the list of APIs, select all the scopes listed under it, and click Authorize APIs.
- You will then be prompted to allow permission, click Allow.
- Under Step 2, click Exchange authorization code for tokens to generate and display the access token and refresh token.
Importing the Gmail connector into WSO2 Integration Studio
- Right-click Sample Services in the project explorer and select Add or Remove Connector.
- Select Add Connector and click Next.
Scroll down and select Gmail from the list of connectors. Then, click the Download icon to download the Gmail connector.
- Click Finish. to close the store view. The connector is now downloaded into your WSO2 Integration Studio and the connector operations will be available in the Gmail Connector palette.
Let's use these connector operations in the configuration.
Creating the Deployable Artifacts
The connector operations are used in the PaymentRequestProcessingSequence. Select this sequence and do the following updates:
Add a Property mediator just before the Call mediator to retrieve and store the patient's email address.
With the Property mediator selected, access the Property tab of the mediator and fill in the information in the following table:
Field Value Property Name Select New Property New Property Name email_id Property Action Select Set Value Type Select Expression Value Expression json-eval($.patient.email) Description Get Email ID
Add another Property mediator just after the Log mediator to retrieve and store the response sent from SettlePaymentEP. This will be used within the body of the email.
With the Property mediator selected, access the Property tab and fill in the information in the following table:
Field Value Property Name Select New Property New Property Name payment_response Property Action Select Set Value Type Select Expression Value Expression json-eval($.) Description Get Payment Response
Drag and drop the init method (from the Gmail Connector palette) next to the Property mediator you added in the previous step.
With the init method selected, access the Property tab. Update the properties as follows:
- Select inline as the Parameter Editor Type.
In the Connector Parameters section, when you click a parameter the Call Template Parameter dialog will open as shown below. Use this dialog to specify the parameter value.
Specify values for the following parameters:
userId The sender's email address. Use the email address that you used to configure the client ID and secret. accessToken The access token you obtained. apiUrl https://www.googleapis.com/gmail clientId The client ID you created. clientSecret The client secret you created. refreshToken The refresh token you obtained.
Add the sendMail method from the Gmail Connector palette after the init method. The updated PaymentRequestProcessingSequence should now look like this:
With the sendMail method selected, access the Property tab. Update the properties as follows:
- Select sendMail as the Parameter Editor Type.
In the Connector Parameters section, when you click a parameter the Call Template Parameter dialog will open. Use this dialog to specify the following parameter values:
Field Value/Expression Description to
Retrieves the patient email address that was stored in the relevant Property mediator. subject Payment Status The subject line in the email that is sent out. messageBody
Retrieves the payment response that was stored in the relevant Property mediator.
- Save the updated sequence configuration.
- Right-click SampleServicesConnectorExporter, navigate to New → Other → Add/Remove Connectors, select Add connector, and click Next. Select Workspace to list down the connectors that were added.
- Select the Gmail connector from the list, click OK, and then Finish.
Packaging the artifacts
Package the artifacts you created above in the SampleServicesCompositeApplication project:
- Open the
pom.xmlfile of the SampleServicesCompositeApplication project, which is already included in the project explorer.
Select the artifact that needs to be included into the CAR file.
Ensure the following artifact check boxes are selected in the Composite Application Project POM Editor.
Starting the Message Broker profile
Start the Message Broker profile as follows:
The Message Broker profile is now ready to receive messages from the ESB profile.
Starting the ESB profile and deploying the artifacts
If you do not already have an ESB server added to WSO2 Integration Studio, follow the instructions in the previous tutorial.
If you have already added the ESB profile server and deployed SampleServicesCompositeApplication (in a previous tutorial):
- Go to the Servers tab and click
- Right-click SampleServicesCompositeApplication and click Redeploy as shown below.
The server Console will indicate that the CApp has been redeployed successfully.
Starting the back-end service
Download and start the back-end service that will process appointment requests:
- Download the JAR file of the back-end service.
Open a terminal and navigate to the location where your saved the back-end service.
Execute the following command to start the service:
The Healthcare service is now active and you can start sending requests to the service.
Sending requests to the ESB
Create a JSON file named
request.jsonwith the following request payload. Make sure you provide a valid email address so that you can test the email being sent to the patient.
Open a command line terminal and execute the following command from the location where the
request.jsonfile you created is saved:
This is derived from the URI-Template defined when creating the API resource.
You will see the response as follows:
An email will be sent to the provided patient email address with the following details:
You have now explored how to import the Gmail connector to the ESB profile of WSO2 EI and then use the connector operation to send emails.