Tutorials

This section provides details about the journey of a user using End-to-End Monitoring. It is used to view the end-to-end details of a business transaction as it moves through the various webMethods.io applications.

Step-by-Step Tutorial

Actors

As part of this user journey, we have two actors here who play their respective roles:

Challenge

Jim reviews many business transactions in a day. These transactions move across the various Software AG applications. Reviewing the transactions helps Jim identify areas of improvement and any errors. In this scenario, XYSsales uses both webMethods.io API and webMethods.io Integration. Jim can view the details of the transactions within the individual systems. For example, on an API execution, he can view its details using the logs in webMethods.io API. In the same manner, when an Integration is run, he can view its details using the logs in webMethods.io Integration. However, if an API calls an Integration in webMethods.io Integration, the log information does not tell Jim which Integration in webMethods.io Integration corresponds to which API execution in webMethods.io API.

To summarize, Jim is unable to correlate the information when a business transaction traverses through multiple systems. He is unable to view the end to end details of a business transaction. We are helping Jim solve this problem by introducing End to End Monitoring.

Hayley sends a request to create a user account using a client application. This triggers a business transaction. Jim wants to view the complete flow of this business transaction. He wants to know the details from the time Hayley sent the request to the time she received the response.

Preconditions

As part of the prerequisites, Jim performs the following actions:

Basic Flow

When Hayley sends a request to create a user account in XYSsales using the client application, following events take place:

  1. The client application calls the REST API APItoCreateAccountinXYSsales. The system applies all the policies defined for this API at this stage of the transaction.

  2. After successful authentication of Hayley’s account credentials with webMethods.io API, the API invokes the Integration CreateAccountinXYSsales which is the REST endpoint.

  3. The Integration is run and it creates the user account for Hayley in XYSsales. On successful creation of the account, the system sends a confirmation message as a response to Hayley through the client application.

  4. Jim can view the details of the API execution through the Analytics tab of the webMethods.io API cloud instance as shown here:

  5. Jim can also view the details of the Integration using the Monitor tab of the webMethods.io Integration instance as shown here:

How does Jim Monitor the Transactions?

  1. Jim logs into webMethods.io Integration.

  2. He selects End-to-End Monitoring from the App Switcher as shown here:

  3. Jim opens the Dashboard of webmethods.io End-to-End Monitoring to view all the transaction groups. By default, the duration selected for view is last half an hour from the current system time. Jim can see the following details:

  4. He selects the group XYSsales which lists all the transactions associated with his enterprise.

  5. He selects the transaction which he wants to view.

  6. On the Business Transaction Details page, he can view all the information for that business transaction as shown here:

  7. On the Business Transaction Details page, he can get more details for each component of the transaction by selecting the component on the Business flow map. When he selects the component, the details are shown in a new pane. For example, Jim selects the Integration Cloud component and he can view the details as shown in the following image:

This completes the user journey for Jim.

Step-by-Step Tutorial - Stages Feature

Actors

As part of this user journey, we have two actors here who play their respective roles:

Existing Setup

Challenge

John reviews numerous business transactions in a day. These transactions move across various environments, stages and Software AG applications. When a transactions fails, John has difficulty in finding out which specific product caused the failure. John also needs to find out the root cause of slow transactions.

Use case 1

Tenant WMIO Flow B2B Channel API Gateway
XYSsalesFinanceDev ComputeXYLogisticAccountCount XYSsalesChannel, Sender:XYSsales InvokeXYSsalesInfo

How does John find the root cause?

  1. John logs into his Software AG cloud tenant XYSsalesFinanceDev. It lists all the products that he currently uses for his business needs.

  2. John now selects webMethods.io Integration, and selects Monitor tab to view all transactions specific to webMethods.io Integration.

  3. He selects End-to-End Monitoring using the app switcher.

  4. John now selects Administrator on his user profile link and ensures that the environment group listing is setup right to view his transaction.

  5. He selects a time range to cover the time window of Emma’s transaction.

  6. John now makes Environment group and Stages in View selections on the masthead filters to simplify locating his transaction.

  7. John is now able to locate the transaction he is looking for within the All Transactions group.

  8. Selecting the transaction allows him to view the full flow of the business flow map, and also shows him the finer details of time delay and failure reason, if any.

  9. For further detail John can click on the More details link of that product and traverse to the product detail monitoring page.

Use case 2

This use case is an exact replica of use case 1, with the only exception that this is deployed in the production environment. Hence, John will be executing the same set of steps listed above with the below exceptions.

Tenant WMIO Flow B2B Channel API Gateway
XYSsalesFinanceProd ComputeXYLogisticAccountCount XYSsalesChannel, Sender:XYSsales InvokeXYSsalesInfo

Finding the root cause for use case 2

  1. This time, John logs into his Software AG cloud tenant XYSsalesFinanceProd.

  2. He verifies environment group listing and does time range selection just as in use case 1.

  3. His masthead filter selections will now be Finance and Production.

  4. He now easily locates his production transaction and looks into more details.

Use case 3

Tenant Finance WMIO REST API Called WMIO workflow Logistics WMIO workflow
XYSsalesLogisticDev GetConsumedCouponDetails ConsumedCouponDetails ComputeConsumtionOnGivenDates

Finding the root cause for use case 3

  1. John now logs into his Software AG cloud tenant XYSsalesLogisticDev.

  2. He verifies environment group listing and does time range selection just as in use cases 1 and 2.

  3. His masthead filter selections will now be Logistics and Development.

  4. He locates the logistics transaction and looks into more details.

Step-by-Step Tutorial - Hybrid Monitoring

Actors

As part of this user journey, we have two actors here who play their respective roles:

Existing Setup

Challenge

John reviews numerous business transactions in a day. These transactions move across many Software AG cloud solutions and Software AG webMethods.io Integration Server. When a transaction fails at Software AG Integration Server, Emma has difficulty in analysing the failure as there is no solution that tracks transactions between Cloud and on-premises products.

Use case

Tenant WMIO Flow B2B Channel API Gateway Integration Server
XYSsalesSCM XYSSCMComputetaionsAndProductDeliveryManagement XYSsalesChannel, Sender:XYSsales InvokeXYSsalesInfo XYSDeliveryManagementServices

How does John find the root cause?

  1. John logs into his Software AG cloud tenant XYSsalesSCM. It lists all the products that he currently uses for his business needs.

  2. John now selects webMethods.io Integration, and selects Monitor tab to view all transactions specific to webMethods.io Integration.

  3. He selects End-to-End Monitoring using the app switcher.

  4. He selects a time range to cover the time window of Emma’s transaction.

  5. John is now able to locate the transaction he is looking for within the All Transactions group.

  6. Selecting the transaction allows him to view the full flow of the business flow map, and also shows him the finer details of time delay and failure reason, if any.

    Note: The tool tip on each node provides him more details.

  7. If failure of the transaction is in the on-premises Integration Server node, John can expand the Integration node and analyse individual services for failures and delays.

  8. For an in-depth analysis John can also check End-to-End Monitoring Hybrid Integration log files in on-premises Software AG Integration Server file system:

    <Install-Dir>/IntegrationServer/instances/default/logs