iCalendar Integration

iCalendar Integration

OFBiz work efforts can be accessed with third-party calendar programs that support the iCalendar file format. This is a convenient way to manage events and tasks.

To use the iCalendar feature, you need to perform three steps:

1. Create an iCalendar
2. Assign parties, fixed assets, and work efforts to the iCalendar
3. Configure your calendar client to access the iCalendar

Create An iCalendar

Click on the iCalendar tab, and then click on the Create button in the Find iCalendars screen.

OFBiz will automatically assign you to the iCalendar as the calendar owner. If you change the owner to another party, you won't be able to modify the calendar - because only the calendar owner can modify the calendar.

Give the calendar a name.

The Calendar Visibility fields control the iCalendar's visibility to others. If visibility is set to Private, then only the calendar owner can view or modify the calendar. If the visibility is set to Confidential, then parties assigned to the iCalendar as a Delegate can also view or modify the calendar. If the visibility is set to Public, then anyone can view the calendar, but only the calendar owner and calendar delegates can modify it.

The calendar visibility From and To fields can be used to make a calendar visible during a range of time.

Save the iCalendar and make a note of the iCalendar URL.

Assign Parties, Fixed Assets, And Work Efforts To The iCalendar

You can assign parties to the iCalendar. Parties assigned to the calendar as Delegates have permission to modify the calendar. Parties assigned to the calendar as Members will have all of their Public events and tasks (work efforts) published to the calendar. Members do not have permission to modify the calendar.

Click on the Parties tab to assign parties to the calendar. Click on the lookup button next to the Party Id field to select a party. Select a Role Type. The From and Through dates specify a range of time the party will be assigned to the calendar. Click Add to assign the party to the calendar.

You can assign fixed assets to the iCalendar. Fixed assets assigned to the calendar will have all of their Public events and tasks (work efforts) published to the calendar.

Click on the Fixed Assets tab to assign fixed assets to the calendar. Click on the lookup button next to the Fixed Asset Id field to select a fixed asset. The From and Through dates specify a range of time the fixed asset will be assigned to the calendar. Click Add to assign the fixed asset to the calendar.

If you use the Work Effort application, you can assign work efforts to the calendar. Find the iCalendar using the Find Work Effort screen (Work Effort Type Id = Publish Properties), then click on the Children tab to add child work efforts. All child work efforts will be visible in the calendar - regardless of their scope.

Configure Your Calendar Client

Configure your calendar client to use the iCalendar. The calendar's full URL is the OFBiz server's HTTPS URL, plus the iCalendar URL. For example:

. Some calendar clients might need a file name:

.

Using The Calendar

If you set up write access in your calendar client, you will be able to update existing work efforts. There are some restrictions imposed by the iCalendar format - for example, only the event or task organizer can update the event or task.

Using OFBiz To Publish Public Calendars

There are many free public iCalendar files available on the internet (holiday calendars, sports team schedules, venue schedules, etc). Typically, users download these files to their local hard drive and include them in their calendar client program. It would be preferable to use OFBiz to publish those calendars instead of having multiple local copies. The advantage is, if the calendar changes, it only needs to be updated in one place.

To publish a public calendar, just create a public iCalendar as described above. Click on the Data tab. Download the desired iCalendar file from the internet, then copy the file's contents into the Data field that is on on the Data tab.