Using Oracle WebLogic Integration Worklist Console
Business Calendar Configuration
This section provides the information you need to use the Business Calendar module of Oracle WebLogic Integration Worklist Console.
Note:
You must be logged in as a member of the Administrators, IntegrationAdministrators, or IntegrationOperators group to map, import, or otherwise modify a business calendar. See Oracle WebLogic Integration Users, Groups, and Roles.
About Business Calendars and Business Time Calculations
Business calendars represent the operating hours of a business. A business calendar specifies a time zone and a set of time period rules. The time period rules determine the days, dates, and hours that are free (available for business activities) and busy (unavailable for business activities). Time period rules are evaluated in sequence as follows:
Rules that appear later in the list supersede rules that appear earlier in the list.
Intervals for which there are no rules are busy intervals.
A business calendar can be used for business calendar calculation and for checking user availability for a task.
The following examples illustrate how to a business calendar is constructed.
Example 1
The following is an example of a business calendar for the year 2007:
In the above, the first three rules define Mondays and Wednesdays from 9 to 5 as free. By default, all other time is busy. The remaining rules designate the American business holidays that fall on Mondays, Wednesdays, or Fridays as busy, selectively overriding the regular free intervals.
Example 2
The following is an example of a business calendar for a night-shift worker whose regular hours are from 10 PM to 6 AM three nights a week.
Of the calendars defined within Oracle WebLogic Integration, one must be designated as the system calendar. Initially, the system calendar is a default calendar named System Calendar, but you can switch the system calendar designation to a custom calendar at any time.
When allocating worklist tasks to users, the business calendar assigned to a user can be referenced to determine whether or not the user is available. Each user is associated with one of the following:
A named calendar In this case, the specified calendar is used to determine busy and free time.
No calendar In this case, the calendar currently designated as the system calendar is used to determine busy or free time.
In addition to being mapped to users in order to determine user availability, business calendars are used in the calculation of business time. When specifying the times that business events are to take place (such as a message being sent or a particular task instance becoming overdue), you may wish to express time intervals in business time by associating the interval with a business calendar. For example, suppose the following:
A Timer event generator is configured to send a message every 24 hours from January 1 to January 31, 2003.
The business calendar shown in Example 1 is associated with the 24 hour interval. Therefore, the 24 hour interval represents business time calculated against the calendar.
When calculating business time, free time periods are counted to determine when a business time interval has elapsed. Based on the business calendar shown at the beginning of this section, the free days in January fall on the following dates: 3, 6, 8, 10, 13, 15, 17, 22, 24, 27, 29, 31. Since each free day has 8 free hours, a Timer event generator configured to send a message every 24 business hours would send messages at 5 PM on the 8th, 15th, 24th, and 31st.
For more information, see “Defining Channel Rules for a Timer Event Generator” in Event Generators in Using the WebLogic Integration Administration Console.
When calculating business time against a business calendar, if the interval is specified by a mixture of days, hours, and minutes (for example, 3 days, 4 hours, and 5 minutes), the days are accounted for first, then the hours, and finally the minutes. The passage of a day in a business calendar is the passage of any day or date that has any free time defined for it.
If the calculation lands on a time that is busy, the calendar is rolled in the direction of the operation in one minute intervals until the next free time is reached. For example, if the calculation adds time (addBusinessTime method) and the addition lands on a busy time, the result rolls forward in one minute intervals until next available free minute. Alternately, if the calculation subtracts time (subtractBusinessTime method) and the subtraction lands on a busy time, the result rolls backward in one minute intervals until next available free minute. For instance, if the free time is 9:00 AM. to 5:00 PM, the subtraction rolls back to 4:59 PM.
For additional information about the methods available for business calendar operations (for example, determining whether or not a user is free or determining a due date based on the passage of a business time interval), see the com.bea.wli.calendar.api Javadoc.
Overview of the Business Calendar Module
The following table lists the pages you can access from the Business Calendar module. The tasks and topics associated with each are provided.
Page
Associated Tasks
Topics
Business Calendar Management
View a list of business calendars. Calendar name, status (in use: true or false), and type (system calendar: true or false) are displayed.
View business calendar properties. Business calendar name, time zone, time period rules, and type (indication of whether or not the calendar is the system calendar) are displayed.
Remove the business calendar assignment from selected users.
Listing and Locating Business Calendars
The Business Calendar Management page lists the defined business calendars. For each business calendar, the In Use and Is System Calendar status (true or false) are also displayed.
To list and locate roles:
In Worklist Console, select the Business Calendar module.
To locate a specific business calendar, do one of the following:
Filter by business calendar name. Enter the search target, then click Search. The business calendars matching the search criteria are displayed.
Resort the list. Ascending and descending arrow buttons indicate sortable columns. Click the button to change the sort order.
Scroll through the pages. Use the controls in the lower left corner. Go to a page by selecting the page number or by using the arrow buttons to go to the next , previous , first , or last page.
Click Submit to update the rule and return to the View Business Calendar Details page.
To sort the time period rules:
On the View Business Calendar Details page, click Sort Calendar Rules.
The Sort Calendar Rules page is displayed.
Move the position of a rule by clicking the up or down arrow to the right of the rule.
Click Submit to update the list and return to the View Business Calendar Details page.
To delete a time period rule:
In the Time Period Rules table, click the check box to the left of the rule or rules that you want to delete.
Click Delete Rule. A confirmation message appears. Click OK.
Defining a Time Period Rule
The Add Business Calendar Time Period Rule and Update Business Calendar Time Period Rule pages allow you to define the properties of a time period rule. There are three types of rules:
Day of the Week
Calendar Date
Date Range
To define a Day of the Week rule:
From the Time Period Type drop-down list, select Day of Week.
From the Day of Month drop-down list, select Sun, Mon, Tues, Wed, Thu, Fri, or Sat.
Specify the time period interval in 24 hour time format (also known as military time) as follows:
From the Start hour and minute drop-down lists, select the time period start hour and minute.
From the End hour and minute drop-down lists, select the time period end hour and minute.
Note:
If you do not specify start and end times (that is, if 00:00 is specified for both) the Free or Busy status specified in the following step applies to the entire day.
From the Free or Busy drop-down list, select Free or Busy.
To define a Calendar Date rule:
From the Time Period Type drop-down list, select Calendar Date.
In the Year field, specify the year in YYYY format.
From the Month drop-down list, select the month.
From the Day of the Month drop-down list, select the date.
Specify the time period interval in 24 hour time format (also known as military time) as follows:
From the Start hour and minute drop-down lists, select the time period start hour and minute.
From the End hour and minute drop-down lists, select the time period end hour and minute.
Note:
If you do not specify start and end times (that is, if 00:00 is specified for both) the Free or Busy status specified in the following step applies to the entire day.
From the Free or Busy drop-down list, select Free or Busy.
To define a Date Range rule:
From the Time Period Type drop-down list, select Date Range.
In the Year field, specify the year in YYYY format.
Select the time period start date as follows:
From the Start Month drop-down list, select the month.
From the Start Day of the Month drop-down list, select the date.
Select the time period end date as follows:
From the End Month drop-down list, select the month.
From the End Day of the Month drop-down list, select the date.
From the Free or Busy drop-down list, select Free or Busy.
The Associate Users with Calendar page allows you to:
Assign a business calendar to a user.
Remove the business calendar assignment from a user.
Notes:
If a user is not mapped to a calendar, the system calendar is used. To learn how a calendar mapped to a user can be used in determining worklist task dates, see “Task Due Dates” in Creating and Managing Worklist Task Plans in Using the Worklist.
If an authenticator that implements the required MBeans is not configured, the calendar mapping options are disabled. To learn more about the authenticator requirements, see Security Provider Requirements for User Management.
To assign a business calendar to one or more users:
In Worklist Console, select the Worklist module.
From the left panel, select User Profiles. The Worklist Users Summary Page appears.
Click the name of the user to whom you want to associate a business calendar. The Associate User with Calendar page appears.
Specify the e-mail address of the user.
From the Shared Calendar drop-down list, select a named calendar, or select System Calendar.
Click Submit to assign the selected calendar to the user.
To remove the business calendar assignment from one or more users:
In Worklist Console, select the Worklist module.
From the left panel, select User Profiles. The Worklist Users Summary Page appears.
Click the name of the required user. The Associate User with Calendar page appears.
From the Shared Calendar drop-down list, select None.
Click Submit to remove the business calendar association.
You can export and import business calendars. When you export a business calendar, the calendar name, time zone, and business rules are exported in XML format. When you import a calendar, if the name specified by the <sch:name> element in the XML file matches an existing calendar, the rules and time zone defined in the existing calendar are overwritten by the rules defined in the XML file. If the name specified by the <sch:name> element does not match any existing calendar, a new calendar is created.
If the calendar you are importing has the same name as the calendar currently designated as the system calendar, the system flag element <sch:systemFlag>must be set to Y in the XML file. If you are importing a new calendar, or updating a calendar that is not currently designated as the system calendar, the system flag is reset to F on import, regardless of the setting in the XML file.
Click the check box to the left of the calendar to select it.
Click Export.
The File Download page dialog is displayed and you are prompted to open the file or save it to a local directory.
Click Save to download the calendar. The Save As dialog appears.
Navigate to the target directory, specify an appropriate file name, and then click Save.
The calendar is now saved in you target directory.
To import a business calendar:
In Worklist Console, select the Business Calendar module. The Business Calendar Management page appears.
Click Import.
The Import a Business Calendar page is displayed.
Specify the name and location of the XML file in the Business Calendar File field. Click Browse to navigate to the file. The Choose file dialog appears.
Navigate to the source directory, select the appropriate file, and then click Open.
The name and location of the selected file appears in the Business Calendar File field.
Click Submit to import the specified calendar file.
The calendar is imported and listed in the Business Calendar Management page.
Deleting Business Calendars
The Business Calendar Management page allows you to delete selected calendars.
Note:
You cannot delete a calendar if it is in use (mapped to a user) or is designated as the system calendar. See Deleting Business Calendars to update the In Use status.
Click the check box to the left of the calendars that you want to delete.
Click Delete.
Note:
If any of the selected calendars are currently being referenced by a Timer event generator, a warning is displayed. Click Cancel to cancel the delete operation, or OK to anyway delete the selected calendars.
and descending 
arrow buttons indicate sortable columns. Click the button to change the sort order.
, previous 
, first 
, or last 
page.
to the right of the rule.
