Tuesday, December 23, 2014

Configuring an Endpoint Operation for TIBCO API Exchange Gateway


ASG installation comes with default list of examples located in <ASG_HOME>/examples and we are going with BookQuery Project to demonstrate the example and here we configure an Endpoint for GetBooksByAuthor operation present in BooksInterface-service1 service.

  1. Create New Configuration
  2. Configure Partner Group
  3. Configure Partner Data
  4. Configure a Facade Operation
  5. Configure a Target Operation
  6. Configure an Authorization Configuration
  7. Configure a Routing Configuration 
  8. Test the Gateway Configuration

Create a New Configuration 

• Launch GUI. See Starting GUI for details.
• Expand the Projects node.
• Click the Add New Project Configuration () icon. A new configuration name, ASG_Config_uniqueNumId, is created under Projects node.
• Move the mouse pointer over the new project configuration, select rename () icon and change project name (Eg: ASG_Test) and press enter.

Configure Partner Group

• Click the ASG_Test configuration.
• Click the Partner Groups tab.
• Click the Add property (
) icon on the top menu bar.
• Type the values for the fields as shown in the following table.

Group Name supportASG
Email support@tibco.com
Phone 001923456789

Configure Partner Data

• Select the ASG_Test configuration.
• Click the PARTNER tab on the upper right tab.
• Click the Partners on the top menu bar.
• Click the Add property () icon on the upper right to create a new partner.
• Type the values for the fields as shown in the following table.

Partner Name tibcoASG
Partner Email support@tibco.com
Partner Phone 001923456789
Partner Group supportASG (select from drop-down list)


Configure a Facade Operation

• Select the ASG_Test configuration.
• Click the ROUTER tab on the upper right tab.
• Click the Facade Operations tab on the top menu bar.
• Click the Add property (
) icon on the upper right to create a facade operation.
• Type the values for the fields as shown in the following table.

Operation Name queryBookByAuthorBW
SOAP Action “GetBookByAuthorEndpoint”
Operation URI /ServerProcesses/GetBookByAuthorEndpoint
Operation Service Name MWC

Configure a Target Operation

• Select the ASG_Test configuration.
• Click the ROUTING tab on the upper right tab.
• Click the Target Operations tab on the top menu bar.
• Click the Add property (
) icon on the upper right to create a new target operation.
• Type the values for the fields as shown in the following table.


Target Operation Name http.GetBookByAuthor
Type HTTP (select from drop-down list)
Timeout (ms) 30000
SOAP Action “GetBookByAuthorEndpoint”
URI /ServerProcesses/GetBookByAuthorEndpoint
Host 127.0.0.1
Port 9696

Configure an Authorization Configuration

• Select the ASG_Test configuration.
• Click the PARTNER tab on the upper right tab.
• Click the Facade Access tab on the top menu bar.
• Click the Add property (
) icon on the upper right to create a new partner operation.
• Type the values for the fields as shown in the following table.

Partner tibcoASG (select from drop-down list)
Facade Operation queryBookByAuthorBW (select from drop-down list)
Partner Timeout (ms) 5000

Configure Routing Configuration

• Select the ASG_Test configuration.
• Click the ROUTING tab on the upper right tab.
• Click the Routing tab on the top menu bar.
• Click the Add property (
) icon on the upper right to create a new routing configuration.
• Type the values for the fields as shown in the following table.


Operation Name queryBookByAuthorBW (select from drop-down list)
Routing Type Target Operation (select from drop-down list)
Routing Key default
Target Operation http.GetBookByAuthor (select from drop-down list)

On menu bar, click the Save Configuration icon to save the ASG_Test configuration.

Test the Gateway Configuration

  • Run Apache HTTP Server, if not running.
  • Navigate to the TIBCO API exchange Gateway installation home i.e.<ASG_HOME>/bin
  • Start the Core Engine for the ASG_Test configuration as follows:
          On windows platform, type the following command
                     asg-engine –u asg-caching-core –a ASG_Test
          On UNIX platform, type the following command
                    ./asg-engine –u asg-caching-core –a ASG_Test

  • Verify that the Core Engine starts successfully without any errors.
  • In the Core Engine log file, verify that the configuration for operation, services and partner are loaded correctly. By default, the Core Engine log file is asg-caching-core.log which is located under <ASG_CONFIG_HOME>/logs directory.
Test the configured Operation and Target Operation
  • Launch TIBCO Designer
  • Open the following project 
                 <ASG_HOME>/examples/BookQuery
  • Run the following server process and client process
        BooksInterface-service1
        QueryByAuthorClient
  • Verify that the process runs successfully without any errors.



No comments:

Post a Comment

back to top