1. General information
1.1. Description of the control
TimeTable is a timetable or Gantt chart.
1.2. Create a new control
A new timetable can be created as follows from the view page using the toolbar with controls:
- First, clicking the mouse on the view page determines the position at which the new timetable should be placed. This will highlight the selected position with a gray horizontal line. Then just click on “TimeTable” in the toolbar of the view page, fill in the attributes of the new control in the newly opened dialog, and then save. This will insert a new timetable at a pre-selected location on the view page.
- If the desired position is not determined before inserting a new timetable, the new timetable will be inserted at the end of the view page.
1.3. Edit or delete a control
- For each existing control, a pencil icon appears to the left of the control page to change or delete the control's settings.
- Individual controls can be moved vertically on the view page using the Drag&Drop method. Moving consists of grabbing the control, preferably behind its name, and then dragging it to the desired location on the view page.
- Controls can be moved only with the “Drag&Drop” check box located above the toolbar with controls selected. For security reasons, this check box is cleared after each login to the application, so that a control is not moved by accident.
2. List of tabs in the control settings dialog
- General – Setting general properties
- Resources – Setting up Gantt chart resources
- Text – Setting of columns displayed in a timetable or gantt chart
- Tooltip – Settings for columns displayed in details
- Rights – Rights settings
- Administration – Setting other properties
2.1. “General” tab
2.1.1. Name
- The name of the control displayed in the header of the timetable or Gantt chart.
2.1.2. Dictionary...
- The dictionary lists the names of other controls, forms, view pages, categories, applications, and application groups used across the entire application.
- The dictionary search is used to design the correct control name and to maintain the consistency of the nomenclature throughout the application so that controls with the same meaning located in different places in the application are named in the same way.
2.1.3. Data source
- The data source defines the source database records displayed in the timetable or Gantt chart.
- Data source settings are made in the graphical designer of database queries. A detailed description of the database query designer is provided in the separate guide Database query designer.
2.1.4. Type
- Gantt diagram
- Timetable A – a timetable with 15-minute cells
- Timetable B – a timetable with one-hour cells
- The “Default” and “Title” fields are offered in the dialog only for the “Gantt diagram” type.
- The timetable displays one week – the week of the first displayed record, or the current week if no records are displayed. Its rows are the days from Monday to Friday; Saturday and Sunday are added if an event starts on one of them. Its columns are the hours from 6 to 22, extended so that events starting earlier or ending later fit in.
- If the name of the control ends with the characters “++”, Saturday and Sunday are always displayed in the timetable; the characters “++” are not displayed in the name of the control.
- The count in the title of the control in the form “x / y” states how many events are displayed (x) out of the total number of loaded records (y).
2.1.5. Default
- The default view of the Gantt chart determines how events are grouped by date. The user changes the view in the header of the Gantt chart and the selected view is remembered for the user (not for the anonymous user); changing this field and saving the control resets the view for all users.
- If the “Time span by” field of the data source is filled in, a “from-to” filter is displayed above the Gantt chart. If the default “From” and “To” values are not filled in the query, “From” is prefilled with the first day of the current month and “To” according to the view: for days with the last day of the third month and for weeks with the last day of the sixth month counted from the current month, for months with the last day of the year two years later and for years with the last day of the year nine years later.
- The displayed period is shortened to at most one year for days, seven years for weeks and twenty years for months. If the “To” value entered in the “from-to” filter is earlier than “From”, it is set to the “From” value; if the entered period is shorter than one month, “To” is extended to the date one month after “From”. The adjusted “To” value is also written to the filter. Without the “Time span by” field, the Gantt chart displays the period from the oldest to the newest displayed record with the same limits.
- The drop-down list offers the following grouping methods:
- Days – grouping of events by day
- Weeks – grouping events by week
- Months – grouping of events by month
- Years – grouping of events by year
2.1.6. From-To
- Select a text column that receives its default value when a new record is created by clicking on a free space, provided that the new event has a different start and end. If the start and end are the same, this column and the “To” column remain empty.
- The display of events in the timetable or Gantt chart does not depend on this column.
2.1.7. From
- Select a column that specifies the start date of the event in the timetable or Gantt chart.
2.1.8. To
- Select a column that specifies the end date of the event in the timetable or Gantt chart.
- An end without time (at midnight) means that the event lasts until the end of that day.
2.1.9. Title
- Select a column that specifies the title (resource) of the event in the timetable or Gantt chart.
- Headings (resources) are displayed as individual lines of a Gantt chart.
- A second column can be selected next to the title column. If the resources are entered neither manually nor by a query, the rows of the Gantt chart are formed by the combination of both values separated by a slash (“ / ”); an empty second value is not appended. With resources entered manually or by a query, events are assigned to rows by the value of the first column only.
2.1.10. Color
- Default color of all events in the timetable or Gantt chart.
- Each event can have its own color set. In the data source settings, the “Color by” column must be set, according to which the color of the event is determined.
2.1.11. Options
- Allow entering new records
- Checking this box determines whether to allow the user to be redirected to a specific edit form in order to create a new record in the database by clicking on a free space in the timetable cell or Gantt chart.
- Clicking on a free space only prefills the term and resource as default values and opens the edit form; the new record is created only when the form is saved. The script from “Run script” runs only if this box is checked.
- Run script
- Checking this box determines whether a script will be run before entering the edit form to create a new record in the database, which typically plans to populate other values using the “SCHEDULEDEFAULTVALUE” or “SCHEDULEDEFAULTVALUES” server function. A detailed description of the server functions is provided in the separate guide Server functions.
- The following variables can be used in the script. A detailed description of the variables is provided in the separate guide Variables.
- #timetablefrom#
- #timetableto#
- #timetableresource#
- Deny opening records
- Checking this box determines whether all users will be denied access to the edit form to open the displayed database record by clicking on an event in the timetable or gantt chart.
2.2. “Resources” tab
- Definitions of resources that appear as individual lines of a Gantt chart.
- The resource radio button contains the following two types of resource definition:
- Separated by Enter – the list of resource values is set manually, in a text box using values separated by enter
- From query – the resource list defines a database query that is evaluated when opening or updating the view page
- If the resource query ends with an error, the Gantt chart is displayed without rows and the error is written to the “Errors” log.
2.2.1. Save resource ID to the database
- Checking this box determines whether the database event records have a foreign key value stored in the resource value that references the primary key of the resource.
- The dialog offers this box, and it applies, only when resources are defined “From query”.
2.3. “Text” tab
2.3.1. Columns
- Definition of the columns displayed in the text box of a timetable or Gantt chart event.
2.4. “Tooltip” tab
2.4.1. Columns
- Definition of columns of details displayed when hovering the mouse over a timetable or Gantt chart event.
2.5. “Rights” tab
2.5.1. Rights
- Rights define a list of user groups and users who have permission to display the control on the view page.
- For a new control, the rights are prefilled from the control at the position selected before inserting it; if no position is selected, from the rights of the view page.
2.5.2. Replace rights to other controls
- The “Replace rights to other controls” feature is used to unify rights across the entire view page for controls that are related in terms of rights.
- Thanks to the “Show...” link, it is possible to display a list of all controls on the view page, including the setting of the rights of these controls. A check box is displayed for each control to select it. When the control is saved, the same rights are then set for the selected controls.
- An alternative for unifying rights within the entire view page is the overview of the rights settings of all controls, displayed by the “Show summary...” link on the “Rights” tab in the view page settings.
2.6. “Administration” tab
- The “Administration” tab is only displayed for existing controls.
2.6.1. Location
- Select the view page on which the control is located.
- The drop-down list contains the view pages located in the same application and in the same category as the view page on which the control stands. For a view page without a category, it offers only view pages without a category. For a new control, it contains only the current view page.
2.7. “Save”, “Delete”, and “Close” buttons
- “Save” button – Saves changes to the control settings.
- “Delete” button – Permanently deletes the control.
- “Close” button – Closes the control settings dialog without saving changes.