Harbormaster Web Client User's Guide

Accessing the Platform

Login

If you have already registered with the platform, apply your user id and password here. If you have not, you must first register yourself as a new user.

Registration

Provide your user details to create a new user account. In order to avoid sharing your Git password, provide a personal Git access token. This is required in order to commit the generated project files to a Git repository

Password Recovery

Click the “Forgot Password” button to have an email sent to start the process to create a new password.

Tech Stacks

Selecting

Deciding which tech stack to use for your project is as simple as choosing it from the list. Only licensed tech stacks that you have access to will be listed.

Refresh

Click the button if you change the drop-down list filter or know the list of available tech stacks has been updated elsewhere.

Inspect

Click the button to see more details on a selected tech stack.

Download

Click the button to download the selected tech stack package (zip file).

Upload

Click the button to upload a new tech stack package (zip file).

Models

If you are starting a new application, choose from one of the options by clicking the relevant icon based on the format of the model you have.

If you are refactoring new

If you change the drop-down list filter or know the list of available tech stacks has been updated elsewhere.

Model Library

To display a list of previously registered (loaded) models.

List of Models

Model Components

Once a model is selected, its components will be displayed in a tree like structure. You should review the tree to make sure the model was loaded into the Harbormaster meta-model correctly.

Project Options

Each tech stack has its own set of options that need to be set before being able to generate the project you are expecting. Visit each tab to see the set of options. Save the project to persist your options to be used for subsequent project generation sessions.

Resources

A resource is any file you may want to include as part of a project generation session. Importantly, the file will be treated a a Velocity template, so if (optionally) it contains Velocity directives or macros, it will result a different output file. Also, based on how a file of that type is mapped in the mappings.properties file of the tech stack package, the resulting file will be written out to the associated directory.

This is a convenient way of augmenting an existing tech stack file without publishing a new tech stack. Also, it is an easy way to add features to an existing tech stack.

Project Management

New

Click the

button to create a project to save project related details to be accessed later on. In order to create a project you have to first have a tech stack selected and model loaded.

Load

Click

button to load the list of available projects to choose from. Select the project of interest and click the load button.

Save

Click

button to save the project once you are satisified with your selections and inputs.

User Options

The important part of this display is the Personal Git Access Token. Instead of sharing your Git password, you can create a token with your Git provider. This token can be deleted at anytime. Harbormaster will use this token when trying to commit a generated project on your behalf.

Use this page to reset your password.

This page contains the token required to access a running Harbormaster instance from the Harbormaster Command Line Interface (CLI).

Generate

If you have selected a tech stack and a model, then provided input for the tech stack options, you are ready to generate the project.

If you do not intend to commit the generated project files to a Git repo, simply unselect the option. If you do, Harbormaster will verify you have provided Git params before proceeding to generation.

Generating….

While project generation is occurring, Harbormaster will provide feedback based on the current stage.

Complete

Once project generation is complete, details about the session will be displayed.