Case Calendar

Use the Case Calendar view to display events. By default, the view displays due dates for quick tasks and target end dates for case stages.

Use the following configuration options and services to customize the view as needed.

Configuration properties

Set or modify configuration properties for the view in the Configuration properties tab.

Table 1. Case Calendar view
Property	Description	Data type
Case Identifier	Mandatory option that needs to be bound to the input variable caseId.	String
Target Object Store Name	Mandatory option that needs to be bound to the input variable tosName.	String
Calendar Size	Displays the calendar in a large or small size.	CalendarSize (Large/Small )
Calendar View	Displays the calendar in a large size, in a month/week/day view.	CalendarViews (Month View/Week View/Day View)
Display Week Numbers	Displays the week numbers in the calendar in size large. By clicking a week number, the calendar view changes to a week view.	Boolean
Case Calendar Events	Retrieves the case-related calendar events for case stages or quick task due dates.	Service flow

Events

You can assign the following types of event handlers to events:

Calendar day click: Triggered when you click a day tile in the large calendar. For example, use the following code to add an event Calendar by clicking a day tile:

var d = dayObject.date.toISOString().substring(0, dayObject.date.toISOString().indexOf('T'));
var dateStr = prompt('Enter a date in YYYY-MM-DD format', d);
var date = new Date(dateStr + 'T00:00:00');
if (!isNaN(date.valueOf())) {
    me.addCalendarEvent({
      title: 'Dynamic event',
      start: date,
      allDay: true
    });
} else {
    alert('Invalid date.');
}

Calendar event load: Triggered for each calendar event when it gets loaded. For example:

alert("Event Title : " + eventObject.event.title);

Restriction: Limitation and workaround:

If the Case Calendar view is not rendered when it is placed in the Tab section layout, follow these steps to call the Case Calendar render function:

Select the tab section and click Event.
Place the following code snippet in On Tab change event.

var calendar = page.ui.get(<Case Calendar viewID/controlID>);
 if (calendar)
   calendar.render();

For example, if the Case Calendar control ID is Case_Calendar then,

var calendar = page.ui.get("Case_Calendar");
if (calendar)
   calendar.render();

where "Case_Calendar" is the control ID of your calendar.

Internet calendars subscription

You can subscribe to internet calendars to display events from these external calendars in the Case Calendar view. In the view, you can configure these subscriptions for each case instance. The URL you enter for a calendar subscription must use a valid iCalendar (.ics) file format.

For the large calendar and the calendar that is displayed in the modal dialog, case workers can select the Manage calendar subscriptions option in Case Calendar UI view to subscribe to other internet calendars. These subscriptions apply only to the specific case instances where they are configured.

Note: You must add SSL certificates for external URLs. For SSL certificates to WebSphere® Application Server, see Adding the directory server SSL certificate to WebSphere Application Server External link opens a new window or tab

Methods

Additional resources

For information about how to create a coach or page, see Building coaches.
For information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see View properties.