After plugin is installed you have to start initialization process. Vacation Manger will guide you through project creation process and configure all necessary elements in the background (like: Issue Screen Configurations, Workflow, Post-Functions, Security Schemes and more)
First, you have need to be logged in as administrator to an administrator account and then access "Add-onsManage apps" (1) .There are two ways to do it. Either by accessing Manage apps view (2) and then clicking page. Then click Configure (3) button . (note: button is located below Vacation Manager plugin name, cloaked inside a drop-down menu).
...
Alternatively by clicking Initial setup (4) link in the sidebar.
Now you should see first step view. Here it's possible to define a Vacation Manager project:in Vacation Manager app panel or just use “Initial setup” (4) from the sidebar in the app section.
...
1st Step: Define Vacation Manger Project and HR group
On the 1st step you need to set up special project dedicated for Vacation Manger.
| Note |
|---|
Use wisely, app can be used in 1 project only |
...
There are several fields to fill in:
Project Name - required field describing Vacation Manager project name;
Project Key - a project key - that which prefixes each issue in the project;
Project Description - field describing a description of Vacation Manager project;
Project Lead - a required field defines a Vacation Manager project lead, chosen user should have been granted with project management permissions.
HR Group - any user added to a chosen HR group will have a possibility to create Teams and dedicate to it particular users and supervisors. Here 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 .
...
group - this group members will be in charge of assigning vacation days for users, they will be able to create Teams (with users and their supervisors). HR members will also have access to all users statistics. This should be dedicated group.
| Info |
|---|
Here you can read more about Roles and Permissions |
2nd step: Create first Vacation Type
Vacation Type it’s just an issue type with some extra details. Since we are configuring new project (with new workflow, issue creation screens etc) we don’t want to make a mess with your existing issue types configuration and it’s required to create this brand new issue type which will be associated only with Vacation Manager project.
| Info |
|---|
It might look complicated, but don’t worry: at this stage we just need 1 issue type. You will be able to add more after initialization. |
...
There are several fields describing Vacation Type:
Name - Vacation Type name - it will be an issue type
Description - Description of a Vacation Type
Type - there are two kinds of Vacation Types recurring and one time
One-time - choosing this, you will have three another field to fill:“Recurring”and “One time” each one of them has different option and fields to fill in. The usage depends on your needs and configuration:
One time - it can be used for some not regular/exceptional leaves, limited by date or not limited at all for cases like homeoffice/remote work.
End Date - check Yes if you want to Vacation Type have a specified end date, check NO if you do not wish so,
Available Time - checking Yes shows the field where you can specify suggested days number that is to be granted,
Default Day limit - specify days number granted to this Vacation Type (it can be changed later in Vacation Definition configuration),
Save used time to worklog - ability to save used time to worklog,
Display incoming and outgoing vacation warnings - display vacation warnings in user picker fields,
Default values - ability to automatically assigned vacation days for users. More information you can find: Automatically assigned vacation days [2.3.x]
Recurring - choosing this you will have fill these fieldRecurring - something happening with regular periods/time frames:
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 Time - defines if unused days will be rewritten (available) to a next period,
Type of Vacation request period - available options: daily, daily or half-day, daily or hourly
Default Day limit - specify default days number granted to this Vacation Type
every period(it can be changed
at a later timelater in Vacation Definition configuration),
Save used time to worklog -ability to save used time to worklog,
Display incoming and outgoing vacation warnings - display vacation warnings in user picker fields (awesome feature, when someone is on vacation you will know before assigning task to that person)
Default values - ability to automatically assigned vacation days for users
...
, when they are added to teams - something to automate onboarding. For more details go to: Automatically assigned vacation days [2.3.x]
...
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:
...
| Info |
|---|
To dive deep into Vation Types configuration visit: Vacation Type |
3rd step: Summary
Here you can check if all parameters are correct, if needed use “Previous” button to get back to previous step and make adjustments.
...
4th last step - Configuration completion confirmation
When everything goes smoothly you will see this view, with some instruction what to do next.
...
| Tip |
|---|
You have successfully configured Vacation Manager Project with 1st issue type. Follow instructions on screen:
|
...
Next Vacation Manager core elements - Navigation Bar Menu