...
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
The Debug view allows to intercept a message at various points of policy execution and thereby helps to analyze/modify the message at the respective breakpoint. Preferred resource and environment can be chosen from the Select a resource to debug and Environment drop-downs respectively.
...
After creating API project and configuring/adding policies in its resource, click the Debug 
icon present on the menu bar to open 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 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.
Figure 1: Dialog box to choose the Server Group in which the project needs to be deployed
In the Debug view, a preferred resource can be chosen from the Select a resource to debug drop-down. After choosing the resource, the project policies and resource policies are displayed in its respective scopes (see Figure 1). If there are no environments to choose, deploy the API project.
The message panel respective to the environment 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 can be added from the Message panel also.
Adding Breakpoint
Right-click the route where the message has to be intercepted and click the Add Breakpoint option.
Figure 1: Adding breakpoint
The color of the route turns red representing the breakpoint.
Figure 2: Route on which breakpoint is set turning red
| Tip |
|---|
|
Debugging
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 message at that breakpoint is shown in the Response Message panel.
Figure 3: Route turning green in colour and response message appearing below while debugging
In the Response message panel, the details can be edited to be sent. Reset button present next to 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 App Endpoint and it which then turns green in colour.
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 response/error message directly to App endpoint.
Figure 5: Border of the Policy node turning red indicating error in policy
If an error occurs in target end point, it turns red and the response/error message is sent directly to App end point. The error message can be seen in response message received.
Figure 6: TARGET displayed in red font indicating some error on target end point and error message displayed as response message
...
While policy execution, if the rule of the policy is not satisfied, the policy is ignored and its border turns orange as shown in Figure 6the figure above. The policy details of the ignored policy are shown in Figure 8.
...
Click the 
icon present at the upper-right corner of the screen. Message panel appears to start the debug process again as shown in Figure 2.
Refetching an API Project
Click the refresh 
icon on the upper-right corner to fetch the API project again and reload the debug panel.
Removing Breakpoint
Right-click the route in which breakpoint is set and select Remove Breakpoint; the route color turns to default color.
Figure 7: Remove Breakpoint option to remove the breakpoint set
the figure below.
Policy Details panel
Click the policy node to view the policy details.
| Tip |
|---|
|
Figure 87: Policy Details
Removing Breakpoint
Right-click the route in which breakpoint is set and select Remove Breakpoint; the route color turns to the default color.
Figure 8: Remove Breakpoint option to remove the breakpoint set