Configuring a Project

This is a quick start guide on things that should be first configured when starting using Join on your software project. This is not a complete configuration reference but just a list of things that should be done.

Declaring Releases

A release entity just corresponds to a planned release of the software project you are working on. Every entity produced or maneged by Join is then associated to a specific release. A software release of your project will have a major and a minor number, a distinct name and a shipping date.

Screenshot: Menu access for releases management

Releases management

Declaring Integration Process Steps

A step in Join system is a stage that helps defining your own integration process. There is often the need that tests may be performed at stretch by different teams (thus the need of a process). Defining steps and their order, allows you to later build business rules for controlling the lifecycle of your assemblies and your environment updates.

Screenshot: Menu access for steps management

Steps management

Declaring Deliverable Types

Deliverables are a special category of artifacts that are supplied by your project development teams. One of the first task into configuring Join is to declare the deliverable types corresponding to your teams. Only granted users are allowed to make this declaration, so let's begin creating a new user.

Screenshot: Menu access for user creation

User creation

After having created a new user similarly as in standard setup, the application is asking you to assign this user some security roles. 5 default roles exist in Join:

  • admin: have administration privileges such as creating users,
  • architect: have permissions to define project organization such as deliverables, components and resources types,
  • joiner: represents a member of project integration team,
  • manager: is responsible of environment management,
  • supplier: is allowed to supply new deliverables.
In order to declare new deliverable types, user should have the privileges associated to the architect and joiner roles. So check the boxes and update the rights of your newly created user (John Doe here).

Screenshot: Security roles assignation

Roles assignation

Logout from application and re-enter it using you new user login. You may now be able to manage the deliverable types of your project using the Artifacts/Deliverables menu entry has shown below.

Screenshot: Menu access for deliverable types management

Deliverable types management

As said on the deliverable types management pages, types should have a unique identifier and a label for display. One important attribute of type is the keys template: a template that will be used by Join to generate unique identifiers for your deliverables. When supplying a new deliverable, the application will replace the {0} string by the name of the release this delivery is for and the {1} string by the version of the deliverable. For this first example, we declare a simple type that is mandatory into assembly creation and not extracted from SCM (this points will be discussed later).

Screenshot: Deliverable type creation

Deliverable types management

Making a first Delivery

As a first example on what to do once Join been configured, here's how to supply a first deliverable for your project into Join.

Creating a Supplier

Create a user having the supplier security role for one deliverable type you have previously declare (see above for details).

Screenshot: Supplier role assignment

Supplier role assignment

Supplying a Deliverable

Logout from application and re-enter it using the new supplier account login. You may now be able to access the delivery form as shown in screenshot below.

Screenshot: Menu access for making a delivery

Delivery creation

You may now fill the form to supply a new deliverable: choose the release this deliverable is for, give the version information and consign some comments on you delivery. The last field is dedicated to the deliverable file that will be uploaded onto Join server repository.

Screenshot: Delivery creation form

Delivery creation form

As a result, you may see your delivery is now registered and appear in the list. Delivery browsing is accessible to all users so that they can keep in touch with the work done by others...

Screenshot: Delivery browsing

Delivery browsing