Exercise 3.3 – Synchronous Responses

Find an HTTP Client Utility

1. 1. To complete this exercise, an HTTP Client utility application for testing web APIs will be needed.
   2. PilotFish recommends using Postman, a free and easy-to-use application with Windows, Mac, and Linux apps, as well as Chrome browser extensions. All instructions in this exercise will assume that Postman is being used.
   3. To get Postman, and for instructions on how to use it, visit their website.
   4. Any related tool that can manually configure HTTP calls will work as well, including command line tools like CURL.

Create a Route

1. 1. From the eiConsole File Management screen, select the Add Route button.
   2. In the dialog that appears, enter the name Synchronous Responses and select OK.
   3. The Route should now appear in the table on the screen. Double-click it to open it.

Document Source System

1. 1. Select the Source System stage in the Route Editing Grid. The configuration panel will appear at the bottom.
   2. Change the System Name to HTTP POST.
   3. Select the Choose Source Icon button, and scroll down to select one of the generic web icons.

Configure the Listener

1. 1. Select the Listener stage in the Route Editing Grid. The configuration panel will appear at the bottom.
   2. Select HTTP Post from the Listener Type selection box. Optionally, click the … button to open the Module Search Dialog, which provides a faster way to find the module you’re looking for.
   3. In the Request Path configuration text field, write synchronous.
   4. Go to the Advanced tab and scroll down to find the Synchronous checkbox, and make sure it is checked.

Add Regex Processor

1. 1. Select the Processor Configuration tab, and click the Add Processor button.
   2. Select the Regular Expression (RegEx) Processor from the Processor Type selection box. Optionally, click the … button to open the Module Search Dialog, which provides a faster way to find the module you’re looking for.
   3. In the configuration panel below, click the + button to add a row to the Terms and Replacements table. In the RegEx column, write People. In the Replacement column, write Robots.
   4. Click the + button again to add another row. In the RegEx column, write Person. In the Replacement column, write Robot.

Configure the Transport

1. 1. Select the Transport stage in the Route Editing Grid. The configuration panel will appear at the bottom.
   2. Select Synchronous Response from the Transport Type selection box. Optionally, click the … button to open the Module Search Dialog, which provides a faster way to find the module you’re looking for.
   3. No other configuration is needed.

Document the Target System

1. 1. Select the Target System stage in the Route Editing Grid. The configuration panel will appear at the bottom.
   2. Change the System Name to Synchronous Response.
   3. Leave the default icon in place.

Prepare to Test

1. 1. In the menu bar at the top, select Mode -> Testing Mode. Make sure the changes to the Route are saved.

Test Route 

1. 1. Click the Execute Test button. A dialog will appear containing the URL for the Post Listener.
   2. Open Postman or whatever application is available as an HTTP Client.
   3. Copy and paste the URL from the eiConsole Testing Mode to use as the URL for making the HTTP call in the client application.
   4. Select POST as the HTTP Method to use.
   5. Navigate to the sample files directory, and find the file people.xml. Its contents should be in the body of the HTTP Request. In Postman, the file can either be loaded directly or its contents can be copied and pasted into the body section of the UI.
   6. Send the request from the HTTP Client. 7. In the eiConsole, green checkmarks should appear as all Stages are completed. Once it is all finished, a response should be received by the HTTP Client.
   7. In this response, all uses of the word People in the original body were replaced by the word Robots, and all uses of the word Person replaced by the word Robot.