Element Details: Schedule

Available in: Logi Info Source code name: ScheduleIntroduced in: v9.5.14

Schedule displays a collection of controls in the report allowing the end user to easily enter a new schedule.

The user may:
* Select the schedule type. Either Daily, Weekly, Monthly or MonthlyDayOfWeek.
* Specify options for each schedule type.
* Select starting and ending dates and times.
* Select specific days of the week, days of the month and months of the year.

The schedule output is returned as an XML string in a request variable with the ID of the Schedule element. For example, if the ID of the Schedule element is “mySchedule”, use “@Request.mySchedule~” to retrieve the XML. Typically, the XML is stored into the Scheduler service with a Procedure.SchedulerCreateTask or Procedure. SchedulerUpdateTask by setting ScheduleXml=”@Request.mySchedule~”

Schedule defines certain Cascading Style Sheet (CSS) classes. These help with colors, font sizes and spacing. You can over-ride these classes by adding them to your own CSS file. The Schedule’s built-in CSS file is rdTemplate\rdSchedule\rdScheduleStyle.css.

When using Layout="Fixed", also set the Width attribute, otherwise, some parts of the schedule interface may be cut off.

The Format attribute can be used to set the format for the Dates that appear in the schedule. Only formats for dates are allowed.


Click attribute Name to drill down for more information.

NamePossible ValuesDescription
Sets the Cascading Style Sheet class used by the element. When set, this class will also be used by all child elements that don't have their own class. The class should be defined in the report's style sheet file.
Allows a string to be formatted in various ways, especially for numeric and date values. Specifies formatting characteristics for the data. This attribute has been borrowed from the Microsoft Visual Basic Format function. For more information: http://msdn.microsoft.com/en-us/library/59bz1f0h(VS.71).aspx For dates, the non-specific formats, such as "General Date", "Short Time", etc., are converted according to the browser's international setttings. Also, for very large reports, the non-specific formats perform better. There are also some special formats. "<" and ">" change strings to lower and upper case. "Expanded Spaces" preserves space characters that would otherwise be collapsed by the web browser. "HTML" preserves HTML tags so that they are not encoded - they are embedded rather than shown. "Preserve Line Feeds" preserves line feed and cariage return characters so that the following characters appear on a new line. "mp" formats numbers with the "metric prefix". To format 1,234,567 as "$1.23M", use Format "$#.00mp". Supported metric prefixes are from 1000^6 to 1000^-6 For more information: http://en.wikipedia.org/wiki/Metric_prefix "mpsx" formats the value with x number of significant figures in addition to the metric prefix. So a value of 123456, with format set to mps3 will return 123k. "qq" returns the number of the quarter when the value being formatted represents a date. To return the year and quarter together like "2010 Q1", set the format to "yyyy Qqq". "fyy" and "fyyyy" return the fiscal year. "fqq" returns the fiscal quarter. The fiscal year start date may be configured in the settings' Globalization element. "ww" returns the number of the week. The first day of the week may be configured in the settings' Globalization element.
(Required) The ID attribute is a pervasive attribute that uniquely identifies an element within a definition file. The ID needs to be a unique value within the definition.
Determines if the table layout is automatic or fixed. The default is automatic. With fixed, the column layout is determined with the first row, instead of adjusting column widths by examining every row. This can help with formatting issues, and can also significantly improve large table performance.
An list of interval modes to display in the Scheduler. It can limit the type of schedules that can be created and saved. Accepted values are Once, Daily, Weekly and Monthly. You can specify more than one value by separating each value with a comma. If left blank, all modes are available to the user.
Specifies how the Scheduler is displayed. “Horizontal” places the configuration options for the selected interval mode to the right of the interval, start date, end date and start time inputs. “Vertical” places the configuration options below. “Vertical” is the default orientation.
An XML string that represents a schedule. ScheduleXml specifies the schedule that initially appears. It may hard-coded to a specific value, or retrieved from a DataLayer.Scheduler, or passed in from a Report definition that has a Schedule element. To retrieve from a DataLayer, create a LocalData element with DataLayer.Scheduler below. Set the SchedulerTaskID to the ID of an existing scheduled task. Then set the ScheduleXml attribute to “@Local.ScheduleXml~” To hard-code the schedule, set the attribute ShowScheduleXml=”True”, then run the report. Make changes to the schedule with the Schedule element interface and see how the ScheduleXml is updated. Copy and paste the schedule xml text from the interface into the ScheduleXml attribute. Then set ShowScheduleXml back to “False”. To get the value from a Report definition into a Process definition, set ScheduleXml to a @Request token with the ID of the Report's Schedule element.
Specifies if a check-list of days-of-the-week will be displayed for the Weekly interval mode. Default is “True”.
Specifies if a check-list of months will be displayed for the Monthly and MonthlyDayOfWeek interval modes. Default is “True”.
ShowProcessParameters includes controls to add any number of name-value pairs of parameters used to run a scheduled task. This is primarily used for administrative applications that allow complete control of report scheduling. The default is False.
Specifies if the XML generated by the Scheduler element will be displayed to the developer below the element. This is intended to be used for debug purposes only. Default is “False”.
Specifies if the scheduler's user interface should display the server's current time. This can be useful when the user's time zone differs from the server's. The user can infer and adjust the time for running scheduled reports. Default is “False”.
Some elements employ a definition file as a template. The definition contains language and culture specific Caption attributes that you may want to change. Or you may simply want to change the captions to better suit your application. The TemplateModifierFile is an XML file with elements pointing to other elements in the template to be changed. All other attributes get applied in the template. For example, the Dashboard2 element has a template file (rdTemplate\rdDashboard\rdDashboard2Template.lgx) several Label elements. One has an ID="lblAddPanelsTitle". The Caption can be changed with the following XML in the TemplateModifierFile: You can set attributes for any number of elements. Examine the template file to learn the ID and Caption attributes you may want to modify. The above example shows how to identify template elements with an ID attribute. Alternatively, you can also identify elements with an XPath expression. In this example, we change an attribute of the InteractivePaging element: For a more detailed list of modifier actions see the following DevNet article. TemplateModifierFiles can be in any folder accessable to the web application. When a directory location is not specified, the default location is the _SupportFiles folder.
The width of the element.
The width scale of the element. Value can be "px" for pixels, or "%" for percentage of the available width.


Click element to drill down for more information.

Column Cell
Fieldset Box
Popup Panel
Responsive Column
Tab Panel


Click element to drill down for more information.

Generated Element Plugin Call

 Back to top