Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

  1. Create a publish pointan iCalendar
  2. Assign Link work efforts, parties, and fixed assets, and work efforts to the publish pointiCalendar
  3. Configure your calendar client to access the published calendariCalendar

Create

...

An iCalendar publish point is a work effort that contains properties the iCalendar feature uses to publish your calendar. Create a new work effort and set its Type to Publish Properties. Set the Status to Cancelled so it won't show up in normal work effort searches.

You can control the calendar's visibility with the Scope setting:

  1. Private - only the calendar owner can use the calendar
  2. Confidential - only the calendar owner and parties assigned to it in the role of Delegate can use the calendar
  3. Public - anyone can use the calendar

You can control when the calendar is published by using the Actual Start Date and Actual Completion Date fields. When these fields are set, the calender will only be visible within their date range.

Save the publish point work effort and make a note of the work effort's ID - it will be used in the iCalendar URL.

Link Work Efforts, Parties, And Fixed Assets To The Publish Point

You can control which work efforts are visible by assigning child work efforts, parties, and fixed assets to the publish point:

  1. All child work efforts are visible
  2. All Public work efforts of all assigned parties are visible
  3. All Public work efforts of all assigned fixed assets are visible

...

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 published calendariCalendar. The calendar's full URL is the OFBiz server's HTTPS URIURL, plus "/iCalendar/", plus the publish point's work effort IDthe iCalendar URL. For example: https://myofbiz.com/iCalendar/10010. Some calendar clients might need a file name: https://myofbiz.com/iCalendar/10010/MyCalendar.ics?USERNAME=me&PASSWORD=mypasswordhttps://myofbiz.com/iCalendar/10010/MyCalendar.icsImage Removed. If you want write access to the calendar, then you'll need to include authentication parameters: Image Modified.

Using The Calendar

...