Setting up reservation results in the Availability section

In the IBM® TRIRIGA® Workplace Reservation Manager (Reserve) application, the Availability section displays the availability of resources over a period of time. You use the Availability section to find and book available times for reservable resources, such as rooms and equipment. The table area lists the resources, while the chart area displays the free and busy times for these resources. The Availability section is implemented in several areas of the as-delivered Reserve product, such as the Find Available Times tab in the Location Reservation form and Concierge form.

Note: Starting in IBM TRIRIGA Application Platform 3.5.2, the new version of the Availability section replaces the deprecated Java applet with a JavaScript-based DHTML component. Most browsers no longer support Java applets. Meanwhile, the JavaScript-based DHTML component runs in all browsers that are supported in the IBM TRIRIGA Application Platform Compatibility Matrix.

Contents

I. Setting the Maximum Number of Displayed Resources

When the Availability section is rendered, the AVAILABILITY_SECTION_ROW_LIMIT property in the TRIRIGAWEB.properties file limits the maximum number of results to the specified value. If there are too many results, then a warning about exceeding the row size is displayed. The default value is 50 rows. If the value is set to 0, -1, or another invalid value, then the default value is used.

Important: If the property value is set too high, performance issues might occur when the Availability section is rendered. Large values might cause memory issues. It is recommended that you update the underlying reserve queries to reduce the number of results, or design the filters to limit the number of results under this value. Any specified value above the maximum value of 500 is set to 500.

II. Setting the Maximum Number of Meeting Occurrences

In the Availability section, the CALENDAR_EVENT_MAX_OCCURRENCES property in the TRIRIGAWEB.properties file limits the maximum number of occurrences, that are displayed and created for recurring meetings, to the specified value. The default value is 20 occurrences. For example, if you create a recurring event that occurs every week for a year (52 occurrences), then only 20 occurrences are displayed and created in the Availability section. To change this limitation, you can change the default value to another value.

Important: If the number that you specify for the property value gets larger, then the probability that performance will degrade also increases.

III. Setting up the Displayed Columns

At runtime, users can change the columns that are displayed in the table area of the Availability section. To do so, you click the Columns to Display icon on the section toolbar. Then in the Select Columns to Display dialog, you select the columns that you want.

But during setup, you can also change the set of available columns in the Select Columns to Display dialog, which are determined by a query. To do so, you modify the query by modifying the set of columns that are available to users, as follows:

Procedure
  1. Log in to the IBM TRIRIGA application.
  2. From the Tools menu, select Builder Tools > Form Builder.
  3. In the Form Builder, open the form with the Availability section that you want to modify. For example, open the Location Reservation (triReservationManagerLocation) form.
  4. In the form, open the Availability section with the hover tooltip query that you want to modify. For example, open the triSearch tab > All Multi Tab (triAllMultiTab) section > Find Available Times (triAvailabilityAllMT) section.
  5. In the Properties panel, click the link for the query. For example, click the triSpace - Availability - Reserve Query - triReservationManager - All query.
  6. Click the Columns tab.
  7. From the Select Columns to Display on Report list, select the check boxes to add the columns that you want to the Display Columns table.
  8. Click Save & Close.

IV. Setting up the Calendar Set of the Hover Tooltip Query

At runtime, users can hover over the reservations in the chart area of the Availability section to see their related tooltips. These hover tooltips display more information about the reservations, such as the reservation start and end times.

But during setup, you can also change the calendar-set information that the hover tooltip displays. To do so, you identify and modify the calendar set of the hover tooltip query, as follows:

Procedure
  1. Log in to the IBM TRIRIGA application.
  2. Identify the calendar set that you want to modify:
    1. From the Tools menu, select Builder Tools > Form Builder.
    2. In the Form Builder, open the form with the Availability section that you want to identify. For example, open the Location Reservation (triReservationManagerLocation) form.
    3. In the form, open the Availability section with the hover tooltip query that you want to identify. For example, open the triSearch tab > All Multi Tab (triAllMultiTab) section > Find Available Times (triAvailabilityAllMT) section.
    4. In the Properties panel, click the link for the query. For example, click the triSpace - Availability - Reserve Query - triReservationManager - All query.
    5. In the General tab, identify the Calendar Set that is selected. For example, triResourceAvailability.
    6. Close the query and close the form without saving them.
  3. From the Tools menu, select System Setup > General > Calendar Sets.
  4. Select the calendar set that you identified above. Click Edit.
  5. In the Tooltip Columns section, add or delete any tooltips as needed.
  6. Click Save & Close.

V. Styling the Availability Section

In the IBM TRIRIGA Style Manager, you can change the colors of the visual components in the chart area of the Availability section. To do so, you select a component and change its color, as follows:

Procedure
  1. Log in to the IBM TRIRIGA application.
  2. From the Tools menu, select Administration > Style Manager.
  3. In the Style Manager, select Form Styles.
  4. In the Visual Components panel, select the component with the color that you want to change.
  5. In the color palette, select the new color for the component.
  6. To preview a color change, click Use Value.
  7. Click Save.
  8. Clear the browser cache.

a. Table of Visual Components in the Availability Section

The following table lists the visual components in the Availability section whose colors can be changed.

Note: The following default colors might differ with those in IBM TRIRIGA Application Platform 3.5.1 or older.
Visual component Default color Description
Time Window Selector

Green

RGB: 0, 227, 0

HEX: 00E300

 Fill color of the Time Window Selector.
Time Window Selector Border

Red

RGB: 255, 0, 0

HEX: FF0000

 Border color of the Time Window Selector.
Unavailable Period

Dark gray

RGB: 181, 181, 181

HEX: B5B5B5

 Unavailable resource times. For example, based on a reservation calendar.
Tentative Period

Light gray

RGB: 232, 232, 232

HEX: E8E8E8

 Tentatively-accepted reservations.
Event

Dark blue

RGB: 0, 62, 104

HEX: 003E68

 Scheduled reservations.
Series

Dark blue

RGB: 0, 62, 104

HEX: 003E68

 Scheduled recurring reservations.
Series Exception

Dark blue

RGB: 0, 62, 104

HEX: 003E68

 Special events during scheduled recurring reservations. For example, holidays.
Event Buffer

Dark yellow

RGB: 214, 202, 66

HEX: D6CA42

 Buffer time before or after reservations to account for room setup or room breakdown. This component is displayed if setup time or breakdown time or both were specified for a reservable space at the time of the reservation.

VI. Globalizing the Availability Section

The Availability section is globalized for your multicultural users. The language files for the Availability section are located in several places, as follows.

a. Table of Language-File Locations for the Availability Section

The following table lists the language-file locations for the Availability section.

Language files Description
.properties files

Most of the tooltips, messages, and dialogs are found in .properties files that are located on the IBM TRIRIGA application server. The exact folder location of the files depends on the version of the IBM TRIRIGA Application Platform:

  • <server_root>/userfiles/Translations/TreeGrid/<TRIRIGA_platform_version>

The .properties file names follow the format of TextXML_XX.properties, where XX is the language code in Java:

  • To change a translation, edit the TextXML_XX.properties file.
  • To add translations for a new language, copy the TextXML.properties file, and update the file name to be TextXML_XX.properties where the XX is the language code in Java.
Important:
  • If you are extending language support, do not use both the language code plus the country code. The new file name must use the language code only. Then, within your new file, edit the values for the language that you are adding.
  • Do not modify any comments or move around any entries. After your new file is saved, perform tests with a user of that language to make sure that there are no problems with converting the TextXML_XX.properties file into XML on the server.
.xliff files Some of the words in the Availability section are found in the as-delivered language packs. These .xliff file names start with SYSTEMLABEL_LEGACY. In the Globalization Manager tool, you can export these words to an .xliff file by selecting the System Labels option and clicking Export.
.html files (within .war file) The Help text that is shown when the user clicks the Help button in the Availability section toolbar is found in .html files within the ibm-tririga.war file. The .html file names follow the format of Help_XX.html, where XX is the language of the user. You cannot edit or add to these files.

VII. Troubleshooting the Availability Section

To troubleshoot any issues with the Availability section, you can enable Availability logging in the IBM TRIRIGA Administrator Console. Logging information is written to the server.log file in the <TRIRIGA_install>/log folder on the IBM TRIRIGA application server.

To enable Availability logging, you select the logging options, as follows:

Procedure
  1. Log in to the IBM TRIRIGA Administrator Console.
  2. From the Managed Objects list, select Platform Logging.
  3. In the Platform Logging page, select the TreeGrid Availability option or any individual logging options that you want.
  4. Click Apply.

a. Table of Logging Options for the Availability Section

The following table lists the logging options for the Availability section.

Logging option Description
TreeGrid Availability Contains the following 4 logging options.
XML Generation Logs the XML communication between TRIRIGA and TreeGrid in the server.log.
TreeGrid Processing Logs the server activity that is based on requests from TreeGrid to TRIRIGA in the server.log.
TreeGrid Debugging Enables a debugger that displays JavaScript errors and warnings in a window below the Availability section.
Verbose Enables verbose TreeGrid debugging.