Skip to main content

ResourceTimelineViewTemplate

This page provides generated reference documentation for the ResourceTimelineViewTemplate data model.

Displays a calendar component that shows a tree of existing resources on the left side and visualizes scheduled operations for them on the right side. The resource timeline can be used to create, schedule and edit operations

Overview​

PropertySummary
titleTitle of the component
devicesDetermines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices…
entries—
children—
favoriteActionGroup1First action group to place additional actions in
favoriteActionGroup2Second action group to place additional actions in
favoriteActionGroup3Third action group to place additional actions in
entityFieldThis property is mandatory. Its value must be set to
maxDBRowSets the maximum number of data rows to be gathered from the database
hideContentSearchIf set to true, the content search is hidden.
titleFieldEntityfield, that holds the title information. This is used to display the resource.
colorFieldEntityfield, that holds the constant for the color information. This is used as default value for the entries of this resource. When no field is set or the…
initialDateFieldEntityfield, that holds the date which should be initially shown in the timeline. If no field is set or the field returns a null value then the current day is…
parentFieldEntity-field which contains the ParentID.
businessHoursFieldEntityfield, that holds the configuration for the business hours. By specifying it, the business hours will be emphasized. Possible values are:
useUserTimeSlotDetermines whether the user is allowed to set his own displayed time slot.
slotMinTimeFirst time slot that will be displayed for each day.
slotMinTimeProcessProcess that overrides the static slotMinTime and calculates the value by using JDito.
slotMaxTimeLast time slot that will be displayed for each day.
slotMaxTimeProcessProcess that overrides the static slotMaxTime and calculates the value by using JDito.
colspanThe colspan of the element.
rowspanThe rowspan of the element.

title​

Type: String
Constraints: Verification: TITLE_LENGTH

Title of the component

devices​

Type: EDeviceType[]

Determines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices are selected then the component is only available for those selected devices.

entries​

Type: ResourceTimelineViewEntriesDataModel

children​

Type: Children

favoriteActionGroup1​

Type: String

First action group to place additional actions in

favoriteActionGroup2​

Type: String

Second action group to place additional actions in

favoriteActionGroup3​

Type: String

Third action group to place additional actions in

entityField​

Type: String

This property is mandatory. Its value must be set to\

  • #ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View (default).\
  • a single EntityField, if the ViewTemplate uses only this one single EntityField (example: WebContentViewTemplate).
    The second option will result in a performance optimization.

maxDBRow​

Type: Integer
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE

Sets the maximum number of data rows to be gathered from the database

hideContentSearch​

Type: Boolean
Default: true

If set to true, the content search is hidden.

titleField​

Type: String

Entityfield, that holds the title information. This is used to display the resource.

colorField​

Type: String

Entityfield, that holds the constant for the color information. This is used as default value for the entries of this resource. When no field is set or the field-value is empty the brand color is used as default.

initialDateField​

Type: String

Entityfield, that holds the date which should be initially shown in the timeline. If no field is set or the field returns a null value then the current day is used. The format of the date should be in ISO-8601 format uuuu-MM-dd. e.g. 2022-08-30

parentField​

Type: String

Entity-field which contains the ParentID.
This serves as the parent/child mapping for the resources of the timeline component. A value of null within the entityfield is interpreted root.

businessHoursField​

Type: String

Entityfield, that holds the configuration for the business hours. By specifying it, the business hours will be emphasized. Possible values are:\

  • null/empty => no emphasis\
  • JSON array of businessHours
    [
    {
    daysOfWeek: [ 1, 2, 3 ], // Monday, Tuesday, Wednesday
    startTime: '08:00', // 8am
    endTime: '18:00' // 6pm
    },
    {
    daysOfWeek: [ 4, 5 ], // Thursday, Friday
    startTime: '10:00', // 10am
    endTime: '16:00' // 4pm
    }
    ]

useUserTimeSlot​

Type: Boolean
Default: true

Determines whether the user is allowed to set his own displayed time slot.

slotMinTime​

Type: String
Requires: useUserTimeSlot property group

First time slot that will be displayed for each day.

slotMinTimeProcess​

Type: String
Requires: useUserTimeSlot property group

Process that overrides the static slotMinTime and calculates the value by using JDito.

slotMaxTime​

Type: String
Requires: useUserTimeSlot property group

Last time slot that will be displayed for each day.

slotMaxTimeProcess​

Type: String
Requires: useUserTimeSlot property group

Process that overrides the static slotMaxTime and calculates the value by using JDito.

colspan​

Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE

The colspan of the element.

rowspan​

Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE

The rowspan of the element.