Report Tab Property Definitions

The following is a list of controls you can add to a report, with descriptions of their properties:

Report Header

Displayed at the top of the report. A Report Header often contains other field controls, such as Labels and Text Boxes, which display data to the user.

Property Description Sample Value Mandatory or Optional Notes
Background Sets the background color of the control. 0, 0, 255 Optional Defaults to White.
Foreground Represents the control's text color. 0, 255, 255 Optional Defaults to Black.
Height Represents the control's height. 20 Optional Measured in pixels. Defaults to 40.
Name Represents the control's name.

This name is used by stored procedures when extracting the field data from a report.

EmployeeHeader Optional Defaults to <control name> and the number, which increments based on the number of the current control being added. For example, if this control is the fifth Header control being added to the report, the control Name would be ReportHeader5.

You cannot use spaces in control names.

Thickness Represents the control's border. 5 Optional Measured in pixels. Defaults to 1.
Tooltip Represents help text that is displayed when the user moves the mouse over the control. Click to select the appropriate choice. Optional
Top Represents the control's distance from the top margin of the report's grid. 5 Optional Measured in pixels.

Report Footer Properties

Displayed at the bottom of the report. A Report Footer often contains other field controls, such as Labels and Text Boxes, which display data to the user.

Property Description Sample Value Mandatory or Optional Notes
Background Sets the background color of the control. 0, 0, 255 Optional Defaults to White.
Foreground Represents the control's text color. 0, 255, 255 Optional Defaults to Black.
Height Represents the control's height. 20 Optional Measured in pixels. Defaults to 40.
Name Represents the control's name.

This name is used by stored procedures when extracting the field data from a report.

EmployeeFooter Optional Defaults to <control name> and the number, which increments based on the number of the current control being added. For example, if this control is the fifth Footer control being added to the report, the control Name would be ReportFooter5.

You cannot use spaces in control names.

Thickness Represents the control's border. 5 Optional Measured in pixels. Defaults to 1.
Tooltip Represents help text that is displayed when the user moves the mouse over the control. Click to select the appropriate choice. Optional
Top Represents the control's distance from the top margin of the report's grid 5 Optional Measured in pixels.

Page Header Properties

Displayed at the top of each report page. A Page Header often contains other field controls, such as Labels and Text Boxes, which display data to the user.

Property Description Sample Value Mandatory or Optional Notes
Background Sets the background color of the control. 0, 0, 255 Optional Defaults to White.
Foreground Represents the control's text color 0, 255, 255 Optional Defaults to Black.
Height Represents the control's height 20 Optional Measured in pixels. Defaults to 40.
Name Represents the control's name.

This name is used by stored procedures when extracting the field data from a report.

EmployeePageHeader Optional Defaults to <control name> and the number, which increments based on the number of the current control being added. For example, if this control is the fifth PageHeader control being added to the report, the control Name would be PageHeader5.

You cannot use spaces in control names.

Show on First Page Displays the header only on the first page of a multiple-page report. A selected checkbox. Optional
Thickness Represents the control's border. 5 Optional Measured in pixels. Defaults to 1.
Tooltip Represents help text that is displayed when the user moves the mouse over the control. Click to select the appropriate choice. Optional
Top Represents the control's distance from the top margin of the report's grid. 5 Optional Measured in pixels.

Group Header Properties

Displayed at the top of each data grouping. For example, the Employee Report contains two groups: Employee Teams and Employee Names, each of which contains a Group Header and, depending on the report, a Group Footer. For each Group Header, there is an associated Details control that displays report results.

Prop-erty Description Sample Value Mand-atory or Option-al Notes
Back-ground Sets the background color of the control. 0, 0, 255 Optional Defaults to White.
Data-source Data source that this control is referencing. dsEmployee

(references the Data Source named dsEmployee, which references the Employee table)

Optional

The Datafield property value is dependent on the data source.

This field is automatically populated with the data source that is linked to the Details control associated with the Group Header. (This field is populated when the Details control is selected from the Link To field).

If no data source is used with the Details control, this field is left blank.

Fore-ground Represents the control's text color. 0, 255, 255 Optional Defaults to Black.
Group By Specifies the datafield (for example, EMP_ID) by which the output data are grouped in the associated Details section.

If you select Group By fields, each returned value is displayed in its own group section (that is, in its own Details section with a Group Header and Group Footer).

If you do not select Group By fields, the returned values appear in one group section (that is, all values are displayed in one Details section with a Group Header and Group Footer).

EMP_ID Optional. You can only specify data fields that belong to the data source to which the Group Header is linked. For example, if the Group Header is linked to dsEmployee, you can only select from the list of data fields that belong to the Employee table.
Height Represents the control's height 20 Optional Measured in pixels. Defaults to 40.
Link To Links the Group Header to a Details control, from where report results are displayed to the user.

The Group Header is automatically linked to the Data Source associated with the Details control.

Details1 Mandatory Each Group Header must be linked to a Details control. Without a Details section, the report results cannot be displayed.
Name Represents the control's name.

This name is used by stored procedures when extracting the field data from a report.

EmployeeGroupHeader Optional Defaults to <control name> and the number, which increments based on the number of the current control being added. For example, if this control is the fifth GroupHeader control being added to the report, the control Name would be GroupHeader5.

You cannot use spaces in control names.

Repeat With New Page Repeats the header on all additional pages of the report. A selected checkbox. Optional
Thickness Represents the control's border. 5 Optional Measured in pixels. Defaults to 1.
Trigger Page Break Indicates that the header should trigger a new page in the report. A selected checkbox.
Tooltip Represents help text that is displayed when the user moves the mouse over the control. Click to select the appropriate choice. Optional
Top Represents the control's distance from the top margin of the report's grid. 5 Optional Measured in pixels.

Details Properties

Details are used to display report results and are not editable (that is, you can only use controls that display data, such as Labels, with a Details section). A report must have a minimum of one Details control, or section. Without a Details section, a report cannot display results to the user. Information that is displayed in the Details control is repeated for each line of data that is returned by the WFM system when a user runs the report.

Property Description Sample Value Mandatory or Optional Notes
Background Sets the background color of the control. 0, 0, 255 Optional Defaults to White.
Datasource Data source which this control is referencing. dsEmployee

(references the Data Source named dsEmployee, which referenced the Employee table)

Mandatory

If you do not link the Details section to a data source, you cannot display data to the user.

The Datafield property value is dependent on the data source.
Foreground Represents the control's text color. 0, 255, 255 Optional Defaults to Black.
Height Represents the control's height. 20 Optional Measured in pixels. Defaults to 40.
Name Represents the control's name.

This name is used by stored procedures when extracting the field data from a report.

Button5 Optional Defaults to <control name> and the number, which increments based on the number of the current control being added.

For example, if this control is the fifth Button control being added to the report, the control Name would be Button5. We recommend that you change this system-generated name to a more relevant name.

You cannot use spaces in control names.

Repeat with New Page This property indicates that the report's calculations should be repeated with each page. A selected checkbox. Optional
Thickness The thickness of the control's border. 5 Optional Measured in pixels. Defaults to 1.
Tooltip Represents help text that is displayed when the user moves the mouse over the control. Click to select the appropriate choice. Optional
Top Represents the control's distance from the top margin of the report's grid. 5 Optional Measured in pixels.

Page Footer Properties

Displayed at the end of each report page. A Page Footer often contains other field controls, such as Labels and Text Boxes, which display data to the user.

Property Description Sample Value Mandatory or Optional Notes
Background Sets the background color of the control. 0, 0, 255 Optional Defaults to White.
Foreground Represents the control's text color. 0, 255, 255 Optional Defaults to Black.
Height Represents the control's height. 20 Optional Measured in pixels. Defaults to 40.
Name Represents the control's name.

This name is used by stored procedures when extracting the field data from a report.

EmployeePageFooter Optional Defaults to <control name> and the number, which increments based on the number of the current control being added. For example, if this control is the fifth PageFooter control being added to the report, the control Name would be PageFooter5.

You cannot include spaces in control names.

Thickness Represents the control's border. 5 Optional Measured in pixels. Defaults to 1.
Tooltip Represents help text that is displayed when the user moves the mouse over the control. Click to select the appropriate choice. Optional
Top Represents the control's distance from the top margin of report's grid. 5 Optional Measured in pixels.

Group Footer Properties

Displayed at the bottom of each group section. For example, the Employee Report contains two groups: Employee Teams and Employee Names, each of which contains a Group Header and a Group Footer. If you use a Group Footer with a report, you must also use a Group Header. Conversely, you can add a Group Header to a report without a Group Footer.

Property Description Sample Value Mandatory or Optional Notes
Background Sets the background color of the control. 0, 0, 255 Optional Defaults to White.
Foreground Represents the control's text color. 0, 255, 255 Optional Defaults to Black.
Height Represents the control's height. 20 Optional Measured in pixels. Defaults to 40.
Link To Links the Group Footer to a Group Header. GroupHeader1 Mandatory Group Headers that are available for you to link to a Group Footer (that is, Group Header controls that have been added to the current page) are displayed in the Link To drop-down list. Each Group Footer must have an associated Group Header.
Name Represents the control's name.

This name is used by stored procedures when extracting the field data from a report.

EmployeeGroupFooter Optional Defaults to <control name> and the number, which increments based on the number of the current control being added. For example, if this control is the fifth GroupFooter control being added to the report, the control Name would be GroupFooter5.

You cannot use spaces in control names.

Thickness Represents the control's border. 5 Optional Measured in pixels. Defaults to 1.
Tooltip Represents help text that is displayed when the user moves the mouse over the control. Click to select the appropriate choice. Optional
Top Represents the control's distance from the top margin of the report's grid. 5 Optional Measured in pixels.

Report Summary Properties

Specifies summary parameters for the report section, or displays plain text, depending on how you complete the Expression field.

For example, if you place a Report Summary in a Group Footer and specify an #average# Expression, the system displays the average value of datafields from the associated Details section. (When used with JavaScript expressions, Report Summary controls can only be added to Group Footers). Alternately, you can specify text in the Expression field of the Report Summary control in order to display plain text to the user when the report is rendered.

Property Description Sample Value Mand-atory or Optional Notes
Alignment Aligns the text within the control according to alignment specified. Center Optional Defaults to Left.
Background Sets the background color of the control. 0, 0, 255 Optional Defaults to White.
Batch Approvable Displays the control on the Batch Approvals screen (if the form is Batch Approvable). A selected checkbox. Optional
Column Order Organizes columns in CSV and XLS reports. 1 Optional By default, this parameter is set to -1 (which represents relative positioning). This setting works for HTML and PDF reports always, as controls in these reports are positioned using absolute locations. XLS and CSV reports may or may not work using relative positioning, depending on the controls' alignment. Setting up and using this property from the 1st column (Column Order = 0) to the N column (Column Order = N-1) for all label or report summary controls in the headers or footers or details sections, forces the positioning to be correct in any CSV and XLS report.
Datafield A unique field value that is extracted from the associated Data Source control via the data source property. EMP_ID Mandatory, if you are using a data source with the control. Must always be used in conjunction with the data source property.
Datasource Data source which this control is referencing. dsEmployee

(references the Data Source named dsEmployee, which references the Employee table)

Mandatory, if you are using a JavaScript expression with the control. (You do not need to include a data source if you are using the Report Summary to display plain text). The Datafield property value is dependent on the data source.
Display Zero Indicates whether 0 is displayed when the label is a number with a value of zero. If this property is not set, a dot (.) is displayed. A selected checkbox. Optional
Expression Specifies one of the following:

A summary function (that is, JavaScript expression).

Or.

Plain text. If you specify plain text in this field, the text is only visible in the control when the report is rendered.

If you place a Report Summary control with a #count# expression in the Group Footer, the control displays the summary at the bottom of each data grouping.

Alternately, if you specify Name in the Expression field, then Name is displayed to the user when the report is rendered.

Optional. If you do not complete the Expression field, then data or text is not displayed when the report is rendered. Defaults to #value#.

See " JavaScript Expressions ".

F.g. Positive Color if the label is a number with a positive value. 0,0,0 (Black) Mandatory Defaults to Black.
F.g. Negative Color if label is a number with a negative value. 255,0,0 (Red) Mandatory Defaults to Black.
Font Font size. Can also specify bold or italics. 12 pt., Bold, Italic Optional Defaults to 12.
Foreground Represents the control's text color. 0, 255, 255 Optional Defaults to Black.
Height Represents the control's height. 20 Optional Measured in pixels. Defaults to 18.
Left Represents the control's distance from the left margin of the form's grid. 5 Optional Measured in pixels.
Mask The Mask for the label value. Represents a character string that provides the template against which input data is validated. The mask $$$-$$-$$$$ is used to validate a social security number (for example, 123-45-6789) Optional The following special symbols can be used:

? = all letters

@ = any character

$ = digits, '-','+', and '.' signs

[ ] = represents a list of valid chars

All other characters are treated as literals.

Name Represents the name of the control. This name is used by stored procedures when extracting the field data from a form or report. Button1 Optional Defaults to <control name> and the number, which increments based on the number of the current control being added. For example, if this control is the fifth Button control being added to the form, the control Name would be Button5. We recommend that you change this system-generated name to a more relevant name.
Tab order Sets the tab order of the control on the form.

The tab order is the order in which the controls are given focus if the user presses the TAB key to advance from control to control. Starts at 0.

0, 1, 2 Optional
Tooltip Represents help text that is displayed when the user moves the mouse over the control. Click to select the appropriate choice. Optional
Top Represents the control's distance from the top margin of the report's grid. 5 Optional Measured in pixels.
Viewable by Lists the individuals in the workflow who can view this field. All, Sender Optional Defaults to All, Sender.

When used with reports, the user can choose from:

All

Sender

Width Represents the control's width 100 Optional Measured in pixels. Defaults to 72.

Report Properties

This control allows you to set page properties, such as page height, page orientation, paper size, and which page of the report the Report Properties are displayed on.

Property Description Sample Value Mandatory or Optional Notes
Left The distance of the Report Properties control from the left side of the form. 8 Mandatory Measured in pixels. This value defaults to where you initially place the control.
Note: The position of the control is unimportant, since the icon itself is not displayed on the form.
Margin Bottom (px) The size of the margin at the bottom of the page. 20 Mandatory Measured in pixels.
Margin Left (px) The size of the margin at the left side of the page. 20 Mandatory Measured in pixels.
Margin Top (px) The size of the margin at the top of the page. 20 Mandatory Measured in pixels.
Name The name of the Report Properties control. ReportProperties1 Mandatory Click in the Value field and then click to display the Text dialog box. Use this screen when typing names longer than 14 characters.
Page Height (px) The height of the report. 792 Mandatory Measured in pixels.
Page Orientation Specifies how the report is positioned on the page. Portrait orients the report vertically. Landscape orients the report horizontally. Portrait Mandatory Click in the Value field to reveal the orientation drop-down menu.
Page Type Sets the type of paper the report is printed on. Letter Mandatory Click in the Value field and then click on . A drop-down menu displays the following paper types: Custom, Letter, Note, Legal, A3, A4, A5, B3, B4, B5.
Page Width (px) The width of the page. 612 Mandatory Measured in pixels.
Report Criteria Pages Use this option to indicate which page of the report the report criterion is on. Page 1 Mandatory Click in the Value field and then click to display the Select Items dialog box. Select the check box beside the page the report criterion is on.
Note: If the criteria page is not set correctly, the report cannot be generated. WFM currently supports only one criteria page.
Top The distance that the Report Properties control is placed in relation to the top of the form. 184 Mandatory Measured in pixels. This value defaults to where you initially place the control.
Note: The position of the control is unimportant, since the icon itself is not displayed on the form.

Criteria Label

Used to specify report criteria and from where the criteria is gathered (form controls or system elements).

Property Description Sample Value Mand-atory or Optional Notes
Column Order Organizes columns in CSV and XLS reports. 1 Optional By default, this parameter is set to -1 (which represents relative positioning). This setting works for HTML and PDF reports always, as controls in these reports are positioned using absolute locations. XLS and CSV reports may or may not work using relative positioning, depending on the controls' alignment. Setting up and using this property from the 1st column (Column Order = 0) to the N column (Column Order = N-1) for all label or report summary controls in the headers or footers or details sections, forces the positioning to be correct in any CSV and XLS report.
Criteria Elements The controls assigned to the report criteria, selected from controls on the form. CheckBox1

DBListBox1

DatePicker1

Optional In order to assign controls to the Criteria Label control, as report criteria, the controls must be added to the report first.
Criteria Labels The localized labels for criteria controls selected above. Active Employee?

Select Employee

Select Date

Optional You can set criteria labels for English, French, and Spanish locales.
Max Value Length The maximum length of the criteria values. If this length is exceeded when a user enters values, the values are truncated. 8-After 8 characters, the value is truncated. Optional
System Elements The system criteria elements assigned to the report criteria. Rather than the user entering these values (as with the Criteria Elements), these are retrieved from the system. Run DateTime Optional System values that can be used include:

Company Name

Employee Name

Report Name

Run DateTime

Submission DateTime

Username

WFM Company Name

WFM Version

System Labels The localized labels for the system elements. Report Generation Date Optional