CS

View page - Planner

Home / Documentation / Administrator guide / View page /

View page - Planner

CS

1. General information

1.1. Description of the control

Planner is a multi-resource planning calendar.

1.2. Create a new control

A new planner can be created as follows from the view page using the toolbar with controls:

  • First, click on the view page to determine the position in which the new planner should be placed. This will highlight the selected position with a gray horizontal line. Then just click on the “Planner” item 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 planner at a pre-selected location on the view page.
  • If the required position is not determined before inserting the new planner, the new planner 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 planning calendar resources
  • Availabilities – Availability settings
  • Text – Setting the columns displayed in the planning calendar
  • 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 planning calendar.

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. Width

  • The width of the control, expressed in pixels.
  • If this input field is not filled in, the width of the planning calendar will be set to the maximum screen width.

2.1.4. Data source

  • The data source defines the source database records displayed in the planning calendar.
  • 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.5. From-To

  • Select a text column that receives its default value when a new record is created by clicking on a free space and when an event is moved or its start or end is changed, provided that the 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 planning calendar does not depend on this column.

2.1.6. From

  • Select a column that specifies the start date of the event in the planning calendar.

2.1.7. To

  • Select a column that specifies the end date of the event in the planning calendar.

2.1.8. Title

  • Select a column that specifies the title of the event in the planning calendar.
    • Time – Checking this box determines whether the start and end time of the event are displayed before the event title in the format “HH:mm - HH:mm”. The time is not displayed for an event that both starts and ends at midnight.

2.1.9. Resource

  • Select a column that specifies the resource of the event in the planning calendar.
  • Resources are displayed as individual columns of the planning calendar.
  • An event is displayed in the column of the resource that matches its value in the “Resource” column (with “Save resource ID to the database” checked, the ID of the resource record). An event that matches no resource is not displayed – this also applies if the “Resource” column is not selected. The exception is a single resource when the resource query has no filters defined on the “Filters” tab: all events are displayed in its column, including the “Default resource” column.

2.1.10. Color

  • Default color of all events in the planning calendar.
  • 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 the user should be allowed 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 cell of the planning calendar.
  • Run script
    • Checking this box determines whether a script should 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.
      • #plannerid#
      • #plannerfrom#
      • #plannerto#
      • #plannerresource#
    • In this script, the #plannerid# variable always has the value “0”. The #plannerresourcefrom# and #plannerresourceto# variables are empty in this script; only moving an event to another resource fills them.
  • Deny opening records
    • Checking this box determines whether all users should be denied access to the edit form in order to open the displayed database record by clicking on an event in the planning calendar.
    • The restriction applies to clicking on an event. Moving an event or changing its start or end by Drag&Drop opens the edit form even with this box checked (unless “Allow multiple assignments” is checked); only checking “Deny Drag&Drop” prevents moving.
  • Deny Drag&Drop
    • Checking this box determines whether moving the events of the planning calendar by Drag&Drop should be disabled.
    • Moving an event or changing its start or end by dragging opens the edit form of the record with the new term and resource prefilled; the change is saved only when the edit form is saved.
    • If “Allow multiple assignments” is checked, the new term and resource are saved directly, without opening the edit form and without running its scripts, and only for a record the user is allowed to change. Likewise, clicking on a free space creates a new record directly.
  • Show abbreviated name of the day
    • Checking this box determines whether the abbreviated name of the day should be displayed in the lines of the planning calendar along with the date of the day.
  • Allow multiple assignments
    • Checking this box determines whether moving an event, changing its start or end and clicking on a free space are saved directly, without opening the edit form (see “Deny Drag&Drop”).
      • A record saved this way passes neither the validation of the edit form nor its scripts.
      • A newly created record receives only the term, the resource and the values scheduled by the script from “Run script”, which runs before the record is created in this case as well. If navigation scheduled by this script is performed (for example by the “SCHEDULEVIEWPAGE” function), the new record is not created. The default values of the edit form controls are not applied, except for the “From-To” column.
      • This applies to an anonymous user as well. A user may move only an event that the user is allowed to change according to the rights; a new record is always created. All anonymous visitors, however, share a single user account and are therefore the owners of every record created by any of them. If the owner may change a record, any anonymous visitor may thus change records created by another visitor as well.

2.2. “Resources” tab

2.2.1. Resources

  • Definition of resources that appear as individual columns of the planning calendar.
  • The resource radio button contains the following two types of resource definition:
    • Separated by Enter – the list of resource values is set manually, in the text field using values separated by enter
    • From query – the list of resources defines a database query, which is evaluated when opening or updating the view page

2.2.2. 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. “Availabilities” tab

  • Availability definitions that determine when a resource is free for scheduling a new event.
  • In the “Days” view, the parts of an availability that are not covered by events of the same resource starting on the same day are drawn in the resource column as free time blocks. In this view, availabilities apply only if the “Resource” column is selected on the “General” tab.
  • In the “Hours” view, availabilities are not drawn as blocks. The time slots of the displayed day that fall within an availability of the resource have a white background, the other time slots have a gray background.
  • Clicking a free time block behaves the same as selecting the days the block occupies in the column of its resource; without “Allow entering new records” checked, nothing happens. A free time block cannot be moved by Drag&Drop.

2.3.1. Data source

  • The data source defines the source database availability records in the planning calendar.
  • 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.3.2. From

  • Select a column that specifies the start date of availability in the planning calendar.

2.3.3. To

  • Select a column that specifies the end date of availability in the planning calendar.

2.3.4. Title

  • Select a column that specifies the availability title. In the “Days” view, a free time block is displayed with the text “Free - availability title” if the “Title” column is selected on the “General” tab.

2.3.5. Resource

  • Select a column that specifies the resource of availability in the planning calendar – the resource for which availability is intended.

2.4. “Text” tab

2.4.1. Columns

  • Definition of the columns displayed in the planning calendar event text box.

2.5. “Tooltip” tab

2.5.1. Columns

  • Definition of the columns of details displayed when hovering the mouse over a planning calendar event.

2.6. “Rights” tab

2.6.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.6.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.7. “Administration” tab

  • The “Administration” tab is only displayed for existing controls.

2.7.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.8. “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.

3. Working with the planning calendar

  • The planning calendar offers the Days and Hours views.
  • In the “Days” view, clicking a date in the left column switches the planning calendar to the “Hours” view of that day.
  • If more resources are displayed, clicking the name of a resource in the header displays only this resource and “(Active)” is added to its name; another click displays all selected resources again.
  • The “Show resources” icon in the title of the planning calendar displays the list of resources in which the displayed resources are selected; the “Hide resources” icon hides it again. The “Print...” icon is offered only on a computer, not on a mobile device.
  • The drop-down lists in the footer set the width of the planning calendar (100 to 1000 %), in the “Days” view the number of weeks displayed before the selected date (0 to 13, 26 or 52) and from it (1 to 13, 26 or 52), and in the “Hours” view the first displayed hour (0:00 to 10:30) and the last displayed hour (16:00 to 24:00).
  • The planning calendar remembers the selected view, the selected resource, the selection of displayed resources, the width, the number of displayed days and the range of displayed hours for each user separately. The displayed date is restored when printing, after returning from an edit form opened from the planning calendar, and if the user worked with the planning calendar within the last 10 minutes; otherwise the planning calendar opens on the current day.
  • The settings of the planning calendar are not saved for the anonymous user.
  • If no resources are defined, a single column “Default resource” is displayed. If the resource query ends with an error, a single column “Default resource” is displayed as well and the error is written to the “Errors” log.
  • Variables can be used in a manually entered list of resources. Resource names entered in several languages are displayed in the language of the user.