After plugin is installed you have to start initialization process. You have to be logged in to administrator account first and then access "Add-ons" view.
There are two ways to do it. Either by clicking Configuration button in Manage add-ons view (note: button is localized below Vacation Manager plugin name).
Alternatively by clicking Initialize Vacation Manager link in the sidebar.
Now you should see first step view to define Vacation Manager project
There are several fields to fill in:
- Name - required field describing Vacation Manager project name;
- Key - a project key - that prefixes each issue in the project;
- Description - field describing a Vacation Manager project;
- Lead - a required field defines a Vacation Manager project lead, chosen user should have been granted with project management permissions.
After clicking on next button, group define view should appear:
In this step you can define which groups of users will meet individual roles with specific permissions in Vacation Manager. In short, there are three groups:
- Users - they can make vacation requests, and manage their own,
- Supervisors - they can approve users requests,
- HR - they can manage and grant vacations for users. We do not recommend to use common jira groups like jira-users, jira-administators etc. to set groups mentioned above.
Here you can read more about groups and permissions .
Click next, and you should see view to configure first vacation type.
In the third step, you need to define a first Vacation Type.
There are several fields describing Vacation Type:
- Name - Vacation Kind name
- Description - Description of a Vacation Kind
- Type - there are two kinds of Vacation Types recurring and one time
- One-time - choosing this, you will have three another field to fill:
- Has End Date - check Yes if you want to Vacation Type have a specified end date, check NO if you do not wish so,
- Has Suggested Days - checking Yes shows the field where you can specify suggested days number that is to be granted
- Suggested Days - specify days number granted to this Vacation Type (it can be changed later in Vacation Definition configuration)
- Recurring - choosing this you will have fill these field:
- Recurring period - how often Vacation has to start with a new period,
- Period start date - specifies when Vacation Type starts its first period,
- Next periods - shows how period will look like,
- Carryover Days - defines if unused days will be rewritten to a next period,
- Suggested Days - specify default days number granted to this Vacation Type every period (it can be changed at a later time)
- One-time - choosing this, you will have three another field to fill:
You can read more about Vacation Types in Vacation Type section.
Click next. Last view is summary, you can check there if parameters are correct.
Click create to create Vacation Manager configuration.
Next Vacation Manager core elements - Navigation Bar Menu [1.2.x]