Company Calendar for Jira v 1.5.x: Configuring Calendars

To create a new calendar, please click "Add" button at the top-right. Existing calendars can be edited by clicking "Edit" icon assuming that a current user has edit rights. Company Calendar for Jira v 1.5.x: Configuring Calendars#JiraDatesEventSources

General tab

On "General" tab you need to enter a name for a calendar, its type and security restrictions.

"Mixed" calendars allow combining of different types of sources. "Projects only" calendars consist only from "Jira dates" sources but allow direct creation of Jira issues by dragging intervals in the calendar. Additionally, "Projects only" events can be viewed in a calendar that is loaded through the project context menu.

"Calendar Visibility" defines who can access the calendar. Public calendars are accessible by all Jira users. Private calendar are accessible either only by an author or by group members if "Private Group" is set.

"Calendar Editing" control defines who can add, edit, delete the calendar and its event sources. When set to "Private", only creator of the calendar and group members of "Private Group" can change a calendar. This restriction affects only the calendar configuration and other users who have access to the calendar still can create and edit event entries. "Public" value gives full control to all other users so they can edit the current calendar and event sources, moreover they can even delete the calendar.

"Events Editing" field defines who can add, edit and delete events. When set to "Private", only an author and group members of "Private Group" can manipulate events. When set to "Public", all users that have access to a calendar can add, edit and delete its events.

"Calendar Editing" and "Events Editing" options work together. You can restrict events manipulation only if you restrict editing of a calendar.

Events Sources tab

"Events Sources" tab is accessible right after "General" tab is stored.

"Source Type" select-box holds all the event types that are defined in "Calendar Settings" -> "Event Types". To add a new events source, please select "Source Type" and click "Add Source". Right after a screen associated with the selected event type is shown.

Events Source adding and editing 

Different screens are shown depending on an associated event type.

Internal Event Sources

This screen is shown when adding or editing an events source that is associated with one of internal event types. Internal event types are:

• Business trips
• Meetings
• Sick days
• Vacations and leaves
• All custom event types

Only fields to fill are name and color. There 7 predefined colors and you can select a custom color by click on the color field.

Event entries for internal events sources are created through user interface of Company Calendar for JIRA add-on.

Jira Dates Event Sources

This screen is shown for events sources that belong to "Jira dates" event type.

Beside the name and the color it has fields that define showing of entries based on "Date" and "Date Time" JIRA fields.

"Display" radio button allows to define filtering. The simplest approach is to import events on a per project basis. "Filter" option allows to select from one of predefined or favorite filters. Source JQL allows to directly enter a JQL.

Use "Single Date" to configure events that do not have defined duration. The select-box holds all available "Date" and "Date Time" fields and it's need to click "Add Date" in order to add a date entry. Events that correspond to "Date" type field are shown as all day events. "Date Time" fields result into events that have exact time.

Use "Date Range" to configure events that have duration based on configured start and end fields. After selecting the fields that correspond to start and end of a period it's need to click "Add Range". If start and end fields have "Date" type the period is shown in all-day section of the calendar. Otherwise the period entry is shown as continuous block that has start and end time.

Use "Issue Field" to define fields to be shown in information and edit dialogs.

For "Projects only" calendars "Jira dates" source configuration allows to set either single date or date range. Also the source is always tied to a single project. "Source JQL" here gives ability to introduce additional filtering on a project level. Please see the screen-shot:

ICal Event Sources

This is a screen for events sources that have type "iCal".

Here you can provide an URL to a web resource that returns iCal data or you can upload iCal file. When providing an URL please make sure that it's publicly accessible.

For example, you can fetch events from a google calendar and show them alongside with Jira and custom events. The google calendar iCal URL can be retrieved on a calendar settings screen:

Majority of organizers and calendars have iCalendar export or iCalendar feed so you can embed your existing calendars into Company Calendar for Jira.