Project configuration

This section contains general project settings, like name and start date

Example

project:
  start: 2020-06-01                                      # Start date of the project. [Mandatory]
  name: Testproject                                      # Name of the project. [Optional]
  businesshours: MON:10h, TUE:8h, WED:8h, THU:8h, FRI:6h # Business Hours per week. [Optional]
  timeperday: 8h                                         # Max time per day. [Optional]

Start

Type: Date

Sets the first day of the project. All days before this day are considered invalid.


Name

Type: String

Declares the name of the project. This will show up as the title of the generated charts. When a project is imported from another project, the name is used as the name of the top-level group of the imported project.


DefaultWorkingTime

Type: Special since v0.9.6

The property defaultworkingtime sets the default time per day for resources to work on tasks, unless configured differently for a resource. See workingtime for resources.

The default working time is 8 hours per day, Monday to Friday.

As in the workingtime for resources, the defaultworkingtime property can configure:

  1. On which days a worker will be available for tasks
    You can do this by setting a comma separated list of weekdays where the worker is available (e.g. MON, TUE, WED, ... or MO, TU, WE, ...)

  2. How many hours the worker is available each individual day by providing a duration, separated by a colon after the weekday (e.g. MON:4h, TUE:6h, WED:2h, ...). The duration is optional, with a default value of 8h (unless configured otherwise in hoursperday).
    Omitted days in this list indicate that the default setting for resources is to not work on this day at all.

Keep in mind that you can configure the workingtime for individual resources independently.

Example

project:
  name: My first project
  workingtime: MON, TUE, WED, THU:4h  # Working from Monday to Wednesday full time, Thursday half time and Friday/Saturday/Sunday off

TimePerDay

Type: Duration since v0.9.6

The value timeperday defines the amount of time that defines a business day. The default value of timeperday is 8h.

This affects the meaning of 1d in any given time span. E.g. with timeperday: 6h a time span of 3d 2h equals 3*6+2 = 20h

Example

project:
  name: My first project
  timeperday: 10h     # sets the amount of time available for any given day to 10h

BusinessHours

Type: Duration since v0.9.6

The value businesshours describes how much time passes for each day of the week. With this setting, you can deviate from the standard configuration of 8h per day from Monday to Friday to other business hours.

An example would be a working week from Monday to Saturday with Wednesday and Saturday only being 4h long:

  businesshours: MON:8h, TUE:8h, WED:4h, THU:8h, FRI:8h, SAT:4h

If you have a length based task with a length of 1w, the sum of all days configured in businesshours determines how many hours this task will progress per week. You are not limited to a total of 40h per week.

By default businesshours resembles a 40h work week with .

In the default setting for businesshours, the value length: 1w or efforts: 1w equals 40h, which would elapse with 8h per day from Monday to Friday. When setting businesshours: MON:8h, TUE:8h, WED:4h, THU:8h, FRI:8h, SAT:4h the value length: 1w will now equal 48h.

Example

project:
  name: My first project
  businesshours: MON:10h, TUE:8h, WED:8h, THU:8h, FRI:6h

Tracking

Type: String since v0.9.11

The value for tracking determines the tracking policy of TaskFalcon. It decides whether TaskFalcon assumes that resources work on any task inside this project according to plan or via explicit bookings.

For a more detailed description see task property ‘tracking.

Example

project:
  name: My first project
  start: 2020-06-01
  tracking: explicit