Docugate Tools for Visual Studio Code

This extension allows the administration of Docugate Cloud templates and their resources directly within Visual Studio Code. It enables document compilation directly within the editor, providing faster feedback on the resulting document.

Features

Upon installation, the extension can be accessed via the Docugate icon located in the Activity Bar. Within the Docugate Sidebar, the following views are shown:

• The Settings View, used for tenant authentication and changes to the extension settings.
• The Template View, used to administrate the templates and its resources

Setting View

In the Setting View the client ID and the client secret of a Docugate Application can be configured. The workflow setting defines a default workflow file that is used for document compilation.

These settings are exclusively saved for the active workspace. Consequently, they must be reconfigured when switching to another workspace or folder within Visual Studio Code. However, users have the option to set these configurations globally using the extension settings.

Template View

In the Template View, all templates for the tenant are displayed. Each template includes a list of its resources, which can be downloaded individually or all at once using the Download all resources button.

When downloaded, each resource is copied into a folder automatically created within the workspace. The folder's name corresponds to the template display name followed by its ID.

When selecting a resource that has already been downloaded, the file is opened automatically in the editor.

In the editor toolbar, the Upload resource button updates the resource for the template. This button is only visible when a resource from the template folders is opened in the editor.

Compilation

To start a compilation it is needed to either open a workflow file or have a default workflow configured in the Setting View. If the active file in the editor is a valid workflow file, it takes precedence over the default workflow file.

To start a compilation, press the Compile document button in the editor toolbar. A notification is then shown, displaying the progress of the compilation. At the end of the compilation a new folder named response is generated in the workspace, containing the result resources and a log file.

If the compilation fails only the log file is created under the response folder. Note that the response folder is cleared at the beginning of each compilation.

Requirements

A Docugate Cloud tenant and a Docugate application are required to use this extension. You can create a Docugate Cloud tenant on get.docugate.cloud. To create a Docugate application you can follow this tutorial.

To use the extension a Workspace or Workspace folder is required to be open in Visual Studio Code.

Extension Settings

This extension contributes the following settings:

• docugate.clientId: Client ID of the Docugate application.
• docugate.clientSecret: Client secret of the Docugate application.
• docugate.workflowFile: Path to the default workflow file to compile.
• docugate.apiBaseUrl: Base url of the Docugate API.