Quick Start
To quickly start with the Natural for Visual Studio Code extension, proceed as described below. More detailed information is provided later in this documentation.
1. Open a folder that represents a workspace created with NaturalONE. Such a folder is recognized by the Natural projects below it: every subfolder which contains a
.natural file, the project properties written by NaturalONE, is a Natural project. See also
Preparing the Workspace.
When the extension recognizes a NaturalONE workspace, it creates the
.vscode folder in the workspace root and adds the following files: a
launch.json file with the default launches
NatDebugDefault and
NatAttachDefault, and a
settings.json file with all Natural preferences and their defaults (see also
Natural Preferences). If these files already exist, the extension leaves them unchanged.
2. Select a Natural project and choose Natural Properties Manager from the context menu.
The first time you use this command for a project, the extension adds a project-specific launch named
Nat_<project> to
launch.json. It derives the configuration from the connection properties in the project's
.natural file. See also
Preparing the Workspace.
If the Synchronize button is enabled, click it to synchronize the project settings. The button appears, for example, when the steplib settings in the .natural and deploy.xml files do not match. Hover over the button to see the inconsistencies that synchronization will resolve.
To adapt the launch used by the project, click maintain launches in the Connection group of the Environment panel.
3. If your Natural Development Server (NDV) uses SSL/TLS, set
"ssl": true in the launch. See also
Maintaining Launches.
If the server also requires SSL authentication, set natural.ssl.truststoreMandatory to true (default: false) and specify the path to your truststore file in natural.ssl.truststore. Configure these preferences under Command Palette > Preferences: Open Settings (UI) > Extensions > Natural Preferences > Workspace, or edit .vscode/settings.json directly.
The extension resolves a relative truststore path against the workspace folder. The first time you use the launch, the extension prompts you for the truststore password and stores it. If natural.ssl.truststoreMandatory is false, no truststore is required.
Now try one of the following:
Build your Natural application. See
Building the Natural Application.