Interfaces

PLANTA project and Outlook

Requirements

The following requirements apply to the integration of PLANTA project with Outlook calendar:

  • PLANTA project must be installed.

  • Outlook must be installed.

  • PLANTA link must be licensed.

Settings

To enable the integration of PLANTA project with Outlook you have to make the following settings:

  • Web Interfaces must be turned on: In the web.conf, the generic_service parameter must be set to "true" (default = deactivated).

  • Web interface 01ba49c1-5476-0e4c-bd4c-b7775a961aa6 "iCalendar Dates" must be active (default = activated)..

  • In order for Outlook to be able to retrieve the calendar, you have to deactivate authentication in the web.conf apikey_auth_filter_generic = false (default = activated)..

Standard Web Interface "iCalendar Dates"

  • The interface is called via GET.

  • It fetches the dates of the resources from the database by filtering.

  • It converts these dates into the iCalendar - format.

  • It passes the calendar to the client.

Adjust the Interface

To adjust the interface you have to take the following steps:

  • Create a new web interface implementation class that inherits from CalendarFeed.

  • The CalendarFeed class has two attributes that determine how the calendar is structured:

    • ASSIGNMENT_CLS points to a class that can turn a date (task name, calc. start, calc. end) into a VEVENT entry.

    • CALENDAR_CLS points to a class that receives a list of ASSIGNMENT_CLS instances on the basis of which it generates a VCALENDAR.

  • Based on these classes you can also create subclasses which modify the behavior and set the appropriate references in the new CalendarFeed subclass.

  • Then, all you have to do is to exchange the GET implementation of the "iCalendar Dates” web interface. It is detected by the Conflict Management Procedure and will then be reapplied after an update.

Milestone Interface for M365 Integration

  • The interface provides milestones and master milestones for multiple projects in a single request and is used by the PLANTA M365 integration for Outlook calendar synchronization.

    • The system considers (master) milestones from active, unlocked projects without an Actual end date, the tasks of which are also unlocked and do not have an Actual end date.

  • For each milestone, an HTML body is generated that includes the project name, the milestone date, the project manager’s estimate of the project, and a direct link to the Dashboard module in PLANTA Project.

  • The webclient_url must be configured in Global Settings (alpha120 with python_id = 'webclient_url').