Availability section properties

To create an availability section, select the tab that is to contain the section and click the Add Section action. Then set the value of the Type property to Availability Section.

Availability sections are not executed in the Form Builder. Instead, the Layout displays a label identifying the section.

"Common section properties" includes information about the following properties in an availability section: Type, Name, Label, Height, Title Bar Color, Visible, Expand Section, Read Only, Show Title Bar, Style Class, Start Row, Row Span, Start Column, and Col Span. The other properties in an availability section follow:

Query

Select the query that defines the resources to display in the availability section. This query identifies which records and which of their fields display in the left side of the availability section. The events for these records are retrieved by using each record's calendar set and displayed in the right side of the section.

Select Workflow

This workflow handles user interactions with the availability section. All user actions trigger this workflow. The workflow is passed two business objects as workflow parameters: a business object presenting the action taken by the user and a business object that conveys the details for the calendar event affected by the action.

If the Create Association property is set, then the Select Workflow will not run when the user selects a resource. Instead, the system will create an association explicitly.

These business objects are system business objects. The workflow detects what action was taken by the user as defined in the first business object and performs the appropriate tasks with the information on the calendar event defined in the second business object. The workflow returns failure and an error message that can be displayed to the user.

The first business object contains the action taken by the user. The name of this system business object is triUserAction and the fields in this business object are as follows:

triActionTX

The action performed. For example, RescheduleEvent or ChangeTimeWindowSelector.

If the action is to delete or cancel, the workflow must provide the processing to support the cancellation. For example, if a reservation is cancelled, the workflow must not only remove the reservation from the resource, but also any associated reservations for meal service and equipment, and ensure any cancellation charges are taken care of.

triSuccessBL

Returned by the workflow to tell whether the user action was a success or a failure.

triUserMessageTX

Returned by the workflow when the action fails. It contains a message to display to the user.

triRefreshStrategyTX

Returned by the workflow to identify what to refresh as a result of the action. The value returned can be one of the following:

none: Refreshes the data in the right side of the availability section.
self: Refreshes the availability section.
parent: Refreshes the tab that contains the availability section under the control of the value of the Session only property in the Modify Metadata task in the workflow. For more information about the Session only property, see "Modify metadata task".

triReturnRecordIdTX

Returned by the workflow to identify what record to open.

The second business object contains the details about the calendar event affected by the action. The name of this system business object is triCalendarEvent and the fields in this business object are as follows:

triEventIdTX: The SpecId of the event acted upon. This is blank if the action does not affect any event or for an occurrence of a recurrence that is not an exception to the recurrence.
triRecurrenceIdTX: The SpecId of the event acted upon when the action affects an instance of a recurring event. This is blank if the action does not affect any event or for a single occurrence event.
triResourceIdTX: The SpecId of the resource affected by the event. This is filled only when the user selects or deselects a resource in the list of resources.
triStartDT: The start date of the event acted upon. If this is empty, triEndDT is also empty.
triEndDT: The end date of the event acted upon. If this has a value, triStartDT also has a value.

For example, the section workflow is triggered when the user changes the time for a resource. The value of triActionTX in triUserAction is ChangeTimeWindow. triCalendarEvent contains the new start date and time and end date and time. The time window selector updates to the new dates and times when the workflow runs a field onchange workflow.

Maximum View Mode

A view mode describes the way days and events are displayed to the user. Select the widest view users are to have when they view the data in this availability section.

The purpose of this property is to control how much data the system has to generate and display to the user. The more data that is generated, the heavier the data load. Month is the default value.

Default View Mode

Select how this availability section first appears to the user. After initial display, the user can change the way events are displayed.

Display time window selector

Select this check box to enable the time window selector in the availability section. The time window selector is a vertical bar that displays a visual indication of the time range for a reservation. The time range is based on the date and time that the user selects in the Start Date and End Date fields in the Reservation Details section of the reservation.

The colors that are used for the Time window selector and reservations are configured in the Style Manager. The style is from the Style Class section property. For details on styling the availability section, see Availability section.

Enable time window selector change

This property is visible only when the Display time window selector property is selected.

Note: The Enable time window selector change property has no function in this release. In previous releases, when the property is selected, the user can drag or resize the time window selector to change the time and length of the reservation.

Enable resource select

When this property is selected, the user can select resources in the resources table on the left side of the availability section.

Enable resource single select

This property is visible only when the Enable resource select property is selected. When the Enable resource single select property is selected, the user can select only a single resource at a time in the resources table on the left side of the availability section. When this property is not selected, the user can select multiple resources.

Create association

This property is visible only when the Enable resource select property is selected. When the Create association property is selected, an association is created or removed between the context record and the resources selected or deselected.

Select Association Type

This property is visible only when the Create association property is selected. You use this property to identify the association to create or remove between the context record and the resources selected or deselected.

Temporary association

This property is visible only when the Create association property is selected. You select this property when the association to be created or removed is temporary. A temporary association no longer exists after the workflow completes.

Alternate Form List

This property identifies the alternate form list to be used to display a record when that record is opened from this availability section. The alternate form used to display the record depends on the module, business object, and form defined for the record.