Workspace & Assistant

What is a workspace?

A workspace is the collection of tools, libraries, documentations put together in a specific directory structure that acts as a Development Environment and facilitates creation, management and build of D2 Plugin projects. D2SV SDK distributable comes in the form of a zip file named as D2SV-SDK-<Version>.zip. After extracting the zip and subsequently executing ws-init.bat successfully in the extracted folder turns it into a workspace.

What is the Assistant?

The workspace assistant is a command line utility that lives within a workspace & provides the functional aspects of the workspace with help of NodeJS & Apache Maven runtimes. While running, the assistant presents users with options to get something done within the corresponding workspace.

To run the assistant, open a command prompt/terminal in a workspace root directory and run

$npm start

Things that the workspace assistant is capable of doing are:

📄️ Creating a plugin

Create a new maven project in the workspace with basic boilerplate for plugin

📄️ Add Smartview application scope perspective

Adds a new fullscreen table-view boilerplate to a plugin project

📄️ Add smartview UI support to an existing plugin project

Adds basic UI boilerplate to a Backend-only plugin project

📄️ Remove a plugin from workspace

Removes a plugin project from workspace

📄️ Add D2-REST controller support to a plugin project

Adds REST service boilerplate to a plugin project

📄️ Build all plugins in the workspace

Builds all the plugin projects present in workspace

📄️ Checkout documentation

Starts the local documentation server and opens documentation homepage in default internet browser

📄️ Checkout samples

Extracts a packaged sample into the workspace

📄️ Add smartview shortcut behavior

Adds a new behavior boilerplate for shortcut-tile to a plugin project

📄️ Add smartview list tile

Adds a list-tile boilerplate to a plugin project

📄️ Add smartview shortcut tile

Adds a shortcut-tile boilerplate to a plugin project

📄️ Add D2FS dialog to a plugin

Adds D2FS Dialog boilerplate to a plugin project

📄️ Add new metadata view to plugin

Adds an additional metadata view boilerplate to a plugin project

📄️ Add new task details view to plugin

Adds an additional task/workflow details view boilerplate to a plugin project

📄️ Add new menu to plugin

Adds a new menu boilerplate to a plugin project