You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/developing/debug/index.mdx
+44-13Lines changed: 44 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,13 +55,13 @@ To debug a program from the Object Browser, right-click on the program object an
55
55
56
56
## General requirements
57
57
58
-
* PTFs
59
-
*Certificates setup on the server
60
-
* created in `/QIBM/UserData/IBMiDebugService/certs` by default
61
-
*IBM i Debug extension
62
-
* installed into Visual Studio Code
63
-
* Local client certificate
64
-
* can be imported with the 'Import local certificate' command
58
+
* PTFs (see below)
59
+
*IBM i Debug extension ([marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.ibmidebug))
60
+
* installed into Visual Studio Code
61
+
*Debug Service Certificates setup
62
+
* created in `/QIBM/UserData/IBMiDebugService/certs` by default
63
+
* Debug Service certificate`debug_service.pfx`
64
+
* Debug Service client certificate`debug_service.crt`
65
65
66
66
## Required PTFs
67
67
@@ -92,16 +92,47 @@ After you have installed the PTFs, the connection inside of Visual Studio Code w
92
92
## Configuring & starting the service
93
93
94
94
<CardGrid>
95
-
96
95
<Card>
96
+
After connecting to a system in Code for IBM i, you can hover over the connection in the bottom status bar to check the Debugger version and status. The status will be `on` if both the Debug Server and Debug Service are running.
97
+
</Card>
98
+
<Card>
99
+

100
+
</Card>
101
+
</CardGrid>
102
+
<CardGrid>
103
+
<Card>
104
+
Clicking on the Debugger status will take you to the IBM i Debugger view. This view shows the status of the Debug Server and the Debug Service. It also allows to start/stop the Debug Server and manage the Debug Service.
105
+
</Card>
106
+
<Card>
107
+

108
+
</Card>
109
+
</CardGrid>
97
110
98
-
After connecting to a system in Code for IBM i, if the PTFs are installed but the service is not configured (i.e. the certificates don't exist) you will see a notice asking if you'd like to open the Walkthrough to configure the Debug Service. Clicking the button will open the Walkthrough.
99
-
100
-
</Card><Card>
111
+
### Start/stop the Server and Service
112
+
<CardGrid>
113
+
<Card>
114
+
The start/stop/restart actions are located on the right of each status. Running one of these actions will refresh the statuses once it's done.
115
+
</Card>
116
+
<Card>
117
+

118
+

119
+
</Card>
120
+
</CardGrid>
101
121
102
-

122
+
<Asidetype="tip">
123
+
Starting and stopping the Debug Server and Service requires the *ALLOBJ special authority.
124
+
</Aside>
103
125
104
-
</Card></CardGrid>
126
+
### Managing the Debug Service
127
+
<CardGrid>
128
+
<Card>
129
+
If the Debug Service is not correctly configured, a warning sign will appear next to it. Expanding the Debug Service node will show the cause of the issue.
130
+
</Card>
131
+
<Card>
132
+

133
+

134
+
</Card>
135
+
</CardGrid>
105
136
106
137
<Asidetype="tip">
107
138
There only needs to be one instance of the Debug Service running and therefore the certificates should only be generated once. All developers share the Debug Service.
0 commit comments