Contents

Popular

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleContents

Table of Contents
indent15px
stylenone

The Debug view allows to intercept the interception of a message at various points of policy execution and thereby helps to analyzein analyzing/modify modifying the message at the respective breakpointbreakpoints.

After creating the API project and configuring/adding policies in its resource, click the Debug  icon present on the menu bar to open the Debug view. This view is displayed only when a server group is selected or when the Gateway server in the server group selected is running and connected to the API Management server. If not, the Server group to debug dialog box appears. Select the Server Group where the project needs to be saved and deployed.

...

In the Debug view, a preferred resource can be chosen from the Select a resource to debug drop-down list. After choosing the resource, the project policies and resource policies are displayed in its respective scopes (see Figure 1).

The message panel respective to associated with the Server Group selected will be displayed at the bottom part of the screen.

This message panel reflects the variables configured in the Documentation page; values .

Tip

Values can be added from the Message panel

...

as well.

 

Adding Breakpoint

Right-click the route where the message has to be intercepted and click the Add Breakpoint option.

...

To start debugging, first enter the missing values (values are entered in Figure 2) of parameters in the Message panel following the descriptions as provided in the Documentation page. After entering the values, click the Send button present at the upper-right part of the Message Panel as shown in Figure 2. The message is intercepted at the first breakpoint and the route starts blinking in green color and the . The message at that breakpoint is shown in the Response Message panel.


Figure 3: Route turning green in colour color and response message appearing below while debugging

In the Response message panel, the details can be edited to be sent. The Reset button present below the Send button helps to reset the changed details.

After sending messages from all the breakpoints or after every policy execution, the final response is sent to the App Endpoint which then turns green in colourcolor


Figure 4: APP displayed in green font on receipt of the final response

...

If an error occurs while executing a policy, the border of the policy node turns red and the debug process is stopped to send the and response/error message is sent directly to App endpoint.

...

If an error occurs in target end point, it turns red and the response/error message is sent directly to App the App end point. The error message can be seen in the response message received.


Figure 6: TARGET displayed in red font indicating some error on target end point and error message displayed as response message

Ignored Policies

While policy On execution, if the rule rules of the policy is are not satisfied, the policy is ignored and its border turns orange as shown in the figure above. The policy details of the ignored policy are shown in the figure below.

...

Tip
  • Click the green colored route (if it appears) to continue the debug debugging process.
  • Click the green colored API endpoint (if debug debugging is over) to view the response message.
  • Click the Reinjecting Message icon to start restart the debug againdebugging.


Figure 7: Policy Details

...

Right-click the route in which the breakpoint is set and select Remove Breakpoint; the

Info

The route color turns to the default color.


Figure 8: Remove Breakpoint option to remove the breakpoint set

...

Adaptavist ThemeBuilder EngineAtlassian Confluence