os2display/exchange-bundle

Integration to get calendar data from Exchange Web Service.

Installation

Add the git repository to "repositories" in composer.json.

"repositories": {
    "os2display/exchange-bundle": {
      "type": "vcs",
      "url": "https://github.com/os2display/exchange-bundle"
    },
    ...
}

Require the bundle with composer.

composer require os2display/exchange-bundle

To enable the integration, add the following to your config.yml.

os2_display_exchange:
    enabled: true
    host: %os2display_exchange.host%
    user: %os2display_exchange.user%
    password: %os2display_exchange.password%
    version: Exchange2010
    cache_ttl: 1800

Change this to match your setup.

And add the following to your parameters.yml.

os2display_exchange.host: [HOST]
os2display_exchange.user: [USER]
os2display_exchange.password: [PASSWORD]

Enable the bundle in AppKernel.php, by adding Os2DisplayExchangeBundle to $bundles.

new Os2Display\ExchangeBundle\Os2DisplayExchangeBundle()

What the bundle does

The bundle reacts to os2display:core:cron events by looking for slides with slide_type calendar. Each slide should have an array of resources in the slide.options.resources field. Each resource should have a mail field.

The bundle will gather calendar events from the host's EWS for each resource, sort them and insert into the slide.external_data field.

It is possible to set slide.options.interest_interval to how many days into the future the process should gather events for.

Slide tool

The bundle injects the slide tool os2display-email-list-tool that can be used to set the resources.

Service account

The bundle uses an EWS user (service account) that should be set in parameters.yml (together with password) to access calendars in the Exchange. To gain access other accounts, the accounts should "share" their calendars with the service account. Otherwise, the service account will not be able to view the calendar events for the given resource.

Caching

The bundle caches previous results to avoid spamming the Exchange each time the cron process runs. The cache time to live (cache_ttl) can be adjusted for how long a result (in seconds) should be cached.