Skip to main content

Overview

The intra-mart e Builder for Accel Platform extension lets you develop for intra-mart Accel Platform (iAP) inside VSCode. From creating a project to deploying to a server, debugging server-side scripts, and running tests, you can do everything from the VSCode UI.

The extension is split into two

There are two extensions, one per feature area, plus an extension pack that installs both at once. This section distinguishes them as follows.

NotationName on the MarketplaceRole
e Builder (Core)intra-mart e Builder for Accel Platform (Core)Creating and managing projects, deploying to a server
e Builder (Debug)intra-mart e Builder for Accel Platform (Debug)Debugging scripts, running tests
e Builder (Extension Pack)intra-mart e Builder for Accel PlatformInstalls both of the above at once

When referring to both together, we write e Builder (extensions). The pages in this section are also organized around these two extensions.

Difference from the Eclipse-based e Builder

The e Builder (extensions) described in this section are VSCode extensions. They are a different product from intra-mart e Builder for Accel Platform (the Eclipse-based integrated development environment) described in Prerequisites.

The extension pack has the same name as the Eclipse-based integrated development environment. To distinguish them, this section writes the Eclipse-based one as e Builder (IDE).

Take care when using both. For details, see Server-Side Setup.

What e Builder (extensions) Can Do​

There are three things you can do. For details, see the overview of each extension.

  • Creating and managing projects (Core) — Create a development project, update assets, switch the configuration, and build, all from the VSCode UI. There is no need to type commands in a terminal.
  • Deploying to a server (Core) — Transfer a built user module to a staging on the shared development server.
  • Debugging and testing (Debug) — Pause a server-side script (jssp) running on the server at a specified line and step through it one line at a time while inspecting variable values. You can also run test code from a list view in VSCode and check coverage.

When to Use It​

  • You want to create a project or update assets from a UI, without memorizing commands.
  • You want to send built assets to the shared development server and check the behavior right away.
  • You want to investigate why a script does not work as expected, without inserting log output.
  • You want to see what values variables hold while the code actually runs on the server.
  • You have written tests, but typing a command every time you run them has become a chore.
  • You want to know which parts of your code are not covered by tests.

Terminology​

If you are not familiar with debugging and testing terminology, first read Glossary - Visual Studio Code Extension Terms. It covers terms used in this section such as "debugging," "breakpoint," "attach," "step execution," and "coverage."

Prerequisites​

The following are required for all features.

PrerequisiteDetails
VSCode 1.127.0 or laterDesktop only (browser builds such as vscode.dev are not supported)
A trusted folderThe extensions run build scripts and test code, so they do not work in an untrusted folder. For details, see Trusting the Folder

Other requirements depend on which extension you use. For details, see the overview of each extension.

How to Read This Section​

Start with Installing the Extensions, and after that read only the pages for the extension you use.

ExtensionWhen to read it
Creating and Deploying Projects (Core)Creating a project, updating assets, deploying to a server
Debugging and Testing (Debug)Pausing a script to investigate it, running tests

If you do not debug, you can skip all of the Debugging and Testing (Debug) pages, including the server-side setup.

Screen labels assume the English display language

This section shows the extension's on-screen labels in English. The extension's messages follow the VSCode display language, so the extension still works in another language, but the labels you see will not match the text in this section.

To switch, run Configure Display Language from the Command Palette.

Troubleshooting​

The extensions record their execution logs and error details in the VSCode Output panel. When the on-screen message alone does not explain the cause, check there.

  1. Select View → Output from the menu.
  2. Select the extension you want to inspect from the dropdown at the top right.
Dropdown itemWhat is recorded
e Builder (Core)Execution logs for creating, updating, deploying, and building a project
e Builder (Debug)Execution logs for debugging and testing

Behavior that is by design is summarized in Limitations.