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: docs/Configuration.md
+38-51Lines changed: 38 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,94 +8,81 @@ nav_order: 5
8
8
9
9
The settings that define an InterSystems IRIS server and the connection to the server are crucial to the functioning of VS Code in developing in ObjectScript.
10
10
11
-
Open the VS Code Settings Editor by selecting **File > Preferences > Settings** (**Code > Preferences > Settings** on macOS) from the menu, or by pressing <kbd>Ctrl/Cmd</kbd>+<kbd>,</kbd> (comma).
12
-
13
-
> Pro tip: If you know the name of the setting you want to change, or a phrase that occurs in its descrition, start typing this into the 'Search settings' field, for example `intersystems` or `objectscript` or `udl`.
14
-
15
11
## Configuring a Server
16
12
17
-
First, configure one or more servers. Open the settings editor by selecting **File > Preferences > Settings** (**Code > Preferences > Settings** on macOS) from the menu, or by pressing <kbd>Ctrl/Cmd</kbd>+<kbd>,</kbd> (comma).
18
-
19
-
Select the **User** or **Workspace** settings level by selecting it at the top of the settings window. **User** level is normally selected by default, and where to put your server definitions so they can be used by any of your workspaces. You can learn more about the difference between these levels in the [Settings](../settings) section of this documentation.
20
-
21
-
The following screen shot shows **Workspace** selected:
13
+
First, configure one or more servers. Open the settings editor by selecting **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) from the menu. Select the **User** or **Workspace** settings level by selecting it at the top of the settings window. For example, the following screen shot shows Workspace selected:
Find **Extensions** in the list in the left pane of the editor window, click to open, then select **InterSystems Server Manager** from the list to find the correct place in the settings UI.
26
-
27
-
If you don't see this entry, check that you have [installed](../installation) that extension and that it has not been disabled.
28
-
29
-
The following screen shot shows InterSystems Server Manager selected:
17
+
Find Extensions in the list in the left pane of the editor window, click to open, then select InterSystems Server Manager from the list to find the correct place in the settings UI. The following screen shot shows InterSystems Server Manager selected:
30
18
31
19
![Select server manager.](../assets/images/ServerManagerSelect.png"select server manager")
32
20
33
-
And this screen shot shows the Server Manager area of the edit pane:
21
+
And this screen shot shows Server Manager area of the edit pane:
The **InterSystems: Servers** setting is a structured object that is too complex to be edited in the settings UI, so your only option is to click *Edit in settings.json*.
38
-
39
-
If you are defining this setting for the first time, a default settings object will be offered for you to amend. A completion list may also appear. Press <kbd>Esc</kbd> to dismiss this.
25
+
You need to edit the server configuration in the settings.json file, so your only option is to click *Edit in settings.json*.
40
26
41
-
To configure a server, enter something like this:
27
+
To configure a server, enter code something like this:
42
28
43
-
```json
29
+
```js
44
30
"intersystems.servers": {
45
31
"test": {
46
32
"webServer": {
47
33
"scheme":"http",
48
34
"host":"localhost",
49
35
"port":52774,
50
36
},
51
-
"username": "_SYSTEM",
37
+
"username":"_SYSTEM",
52
38
},
53
39
},
54
40
```
55
41
56
42
The components of this server definition are:
57
43
58
-
-**test** - your choice of name to identify this InterSystems server in your settings. The name can only contain lowercase 'a' to 'z', digits 0 to 9, and limited punctuation (`-._~`).
59
-
-**webServer** - a collection of properties that define its associated web server, as follows:
60
-
-**scheme** - protocol used for connections (http or https).
61
-
-**host** - hostname or IP address of the web server server.
62
-
-**port** - port number of this web server. This is the same port as you connect to when using the InterSystems Management Portal from your browser. If you already use InterSystems Studio do not confuse the web server port number with the port number Studio connects to (sometimes called the superserver).
63
-
-**username** - username to use when logging in to this server. This is optional. If omitted the user will be prompted for it at connection time, then cached for the session.
64
-
-**password** - password for the specified username. This is optional, and the example above omits it. Storing the password in a settings file should only be done in limited situations where there is very low need for security or where default credentials are being used (e.g. `_SYSTEM`/`SYS`).
44
+
-**test** - an arbitrary name to identify this server
45
+
-**webServer** - The collection of properties that define the web server.
46
+
-**scheme** - The protocol used for connections.
47
+
-**host** - the host for this server
48
+
-**port** - the WebServer port number for this server
49
+
-**username** - the username to use in logging in to this server.
50
+
-**password** - password for the specified username. Entering the password in this file is acceptable only in limited situations with very low need for security.
65
51
66
-
If you do not add a password to the server definition, the user will need to enter the password when connecting. It will then then be cached for the session. Alternatively you can store the password securely in keychain of your local workstation. The InterSystems Server Manager extension adds the following commands to the Command Palette for managing stored passwords:
52
+
If you do not add a password to the server definition, anyone using the server needs to supply the password. Or, you can store the password securely in the system Keychain. The InterSystems Server Manager adds the following commands for managing stored passwords to the Command Palette:
67
53
68
-
-**InterSystems Server Manager: Store Password in Keychain** - select a server and enter a password.
69
-
-**InterSystems Server Manager: Clear Password from Keychain** - remove password for selected server.
54
+
-**InterSystems Server Manager: Clear Password from Keychain** - remove password for selected server
55
+
-**InterSystems Server Manager: Store Password in Keychain** - select a server and enter a password
56
+
-**InterSystems Server Manager: Test Server Selection**
57
+
-**InterSystems Server Manager: Test Server Selection (flush cached credentials)**
58
+
-**InterSystems Server Manager: Test Server Selection with Details**
70
59
71
60
## Configuring a Server Connection
72
61
73
-
Select **InterSystems ObjectScript** from the settings editor's **Extensions** list. You need to edit the connection configuration in the settings.json file, so click *Edit in settings.json* under the heading **Objectscript: conn**.
62
+
Select InterSystems ObjectScript from the settings editor extensions list. You need to edit the server configuration in the settings.json file, so your click *Edit in settings.json* under the heading **Objectscript: conn**.
74
63
75
64
You should enter code something like this:
76
65
77
-
```json
66
+
```js
78
67
"objectscript.conn": {
79
-
"server": "test",
80
68
"ns":"USER",
69
+
"server":"tst",
81
70
"active":true,
82
71
},
83
72
```
84
-
The components of this connection definition are:
73
+
The components of this server definition are:
85
74
86
-
-**server** - server name as specified in the `intersystems.servers` configuration described in the previous section of these instructions.
87
-
-**ns** - namespace to use on the server.
75
+
-**ns** - namespace to use on the server
76
+
-**server** - server name as specified in the server configuration
88
77
-**active** - specifies whether the connection is active.
89
78
90
79
## Configuring Export from Server
91
80
92
-
Default settings for export are suitable for many situations, but if you need to adjust them here's how.
93
-
94
-
Select **InterSystems ObjectScript** from the settings editor **Extensions** list. Find the section labeled **Objectscript: export**. You can change many of the export settings directly in the settings editor. For others you need to edit the settings.json file.
81
+
Select InterSystems ObjectScript from the settings editor extensions list. Find the section labeled **Objectscript: export**. You can edit many of the export settings in the settings editor. For others you need to edit the settings.json file.
95
82
96
-
When viewed in JSON format your export configuration looks something like this:
83
+
You export configuration looks something like this:
97
84
98
-
```json
85
+
```js
99
86
"objectscript.export": {
100
87
"folder":"",
101
88
"addCategory":true,
@@ -110,12 +97,12 @@ When viewed in JSON format your export configuration looks something like this:
110
97
```
111
98
The components of this export definition are:
112
99
113
-
-**folder** - Folder for source code within workspace.
114
-
-**addCategory** - Add a category folder to the beginning of the export path.
115
-
-**atelier** - Export source code as Atelier did it, with packages as subfolders.
116
-
-**generated** - Export generated source code files, such as INTs generated from classes.
117
-
-**filter** - SQL filter to limit what to export.
118
-
-**category** - Category of source code to export: `CLS` = classes; `RTN` = routines; `CSP` = csp files; `OTH` = other. The default is `*` which exports everything.
119
-
-**noStorage** - Strip the storage definition on export. Can be useful when working across multiple systems.
120
-
-**dontExportIfNoChanges** - Do not rewrite the local file if the content is identical to what came from the server.
121
-
-**maxConcurrentConnections** - The maximum number of concurrent export connections. (0 = unlimited)
100
+
-**folder** - Folder for source code.
101
+
-**addCategory** - Add a category folder to the export path.
102
+
-**atelier** - Export source code as Atelier does, with packages placed in subfolders.
0 commit comments