Chapter 1: System Setup

Report Customizer

The Report Customizer module allows the user to take any existing label, report, or receipt format and customize it to their personal liking.  The customizer allows the user to change the layout, add fields, remove fields, and even create new aggregated fields.  With this feature the user will have the ability to create an unlimited number of layouts for every report so that every type of user can have their own personalized view of the report.

•      To create a custom report layout:

1.  Follow the menu sequence … File | Setup | Report Customizer.

2.  A new window will open up allowing you to select the report for which you wish to create a customization.  Choose a Report from the drop-down list.

3.  On the Manager Tab, after you select the report you wish customize then the following two new options Customization and Preview will be available.  The Customization Section displays all the available customization for the report and allows you to modify or create new customizations.  Let’s see how we can create a new customization.   

4.  Click the New customization link, you will be prompted to name the customization.  Once you have named the customization a new tab with this name is created.

5.  This tab is divided into two sections.  The left portion of the tab displays the standard layout of the chosen report.  The right portion displays the properties for the items located in layout display.

6.  The layout portion is divided into the following four sections: Header, Details, Summary, and Footer. 

•      Header: Items placed in this section of the layout, will appear on the top section of every page that this report layout generates.  Special Actions: This portion of the layout allows you to create a grouping expression under its properties.  If you click on the header tag, in the properties window you will have the ability to click a link call create a new group under this group.  If you click this link the datawindow.header screen is displayed.  In this screen you can create an expression that will organize the data you retrieve according to the expression specified.  This is better illustrated in an example later in this section.

•      Details: Items in this section display the results of the report they do not repeat with every page of the report instead they are continuous.

•      Summary:  Any items that give totals or are cumulative for the entire report should be listed here as they will only be displayed at the conclusion of the report.

•      Footer: Items placed in this section of the layout, will appear on the bottom section of every page that this report layout generates. 

7.  To delete or copy existing items on the report you can select the item then right-click this will give you the options to copy, delete, bring to top, and send to back.  Also, if an item is selected in the layout two new buttons will be available in the toolbar these perform the function of bring to front and send to back.  Copy makes a copy of the item, delete removes the item from the layout, bring to top place the control on the form, send to back hides the control behind the form.

8.  More than one item can be selected from the layout menu, this allows the user to align these items simultaneously to add consistency to the reports appearance.

9.  To modify the location of the items on the form you can click and drag the item to the location on the form where you wish to place it.

10. If you click on the blank form on the top left portion of the layout toolbar or right-click on an empty portion of the form you will have the ability to add new controls to the form, these controls include the following:

•      Text: this adds a new label to the form that will allow you to enter any static text you wish.       This is usually used to label a column or computed field so the user understands what the value is.

•      Column: the Choose a column Screen is displayed and  it allows the user to choose one of the available database columns to add to the report.  Database columns are values stored in the database and their descriptions are usually self explanatory.

•      Compute: the Compute Screen is displayed and it allows the user to create custom expressions using columns, existing computed fields, and system mathematical function.  This expression will add a computed column to the form based on the equation specified.  The Compute Screen is divided into two portions, the expression, and items available to create an expression.  The expression section display the current equation under construction for this computed field.  NOTE: The expression must be a valid mathematical expression. The lower portion displays 5 tabs that allow the user to select the items they wish to use to construct the expression.  These fives tabs are:

•      Columns:  this tab allows the user to select available database columns they wish to use to construct the expression.  

•      Computes: allow the user to use existing computed fields in the construction of the expression.

•      Arguments: is any additional search criteria the user would like available when running this layout of the report.

•      Functions: are available mathematical functions available to be used within the expressions.

•      Constants: allows the user to modify the appearance of the computed field.

•      Check Button: allows the user to check whether the expression created is valid.

•      Line: allows the user to draw a straight line on the form.

•      Ellipse: allows the user to draw an ellipse on the form.

•      Rectangle: allows the user to draw a rectangle on form.

•      Round Rectangle: allows the user to draw a rectangle with rounded edges on the form.

•      Button: allows the user to add a button to the form.  This is of limited use since the user can not add functionality to the button.  However, if the user desires to add a specific functionality using a button our development team could add functionality to buttons.

•      Image: allows the user to add a static image to the form.

•      Group Box: allows the user to add a group box to the form.  A group box allows the user to group other controls into a container which has group properties that can be set.  This is of limited use to the user but can be used by our development team to add specific functionality.

•      Report: allows the user to add an existing report form to this report.  Since the reports are divided into parts this allows the user to reuse various portions of existing reports to customize reports.  This will make your report customizations consistent in information and appearance.

11. Delete Button on toolbar deletes select layout items.

12. Save Button on toolbar saves changes made.

13. To modify the properties of the items on the form you can select the item and then modify its properties in the properties section.  The majority of the items in the form will be text, columns, computed fields, child reports.  In the properties section you have three buttons located on its tool bar, the first button which has two + images organizes the properties by category, the second which has an A – Z image organizes the properties alphabetically, and third which hides/displays advanced properties. The available properties and their functions are listed below for each:

•      Text Control

General

Property

Description

Name

The name of the column.

Tag

(exp) The tag text for the text control.

Hidesnaked

Whether the control appears once per page when printing newspaper columns.

Visible

(exp) Whether the control is visible.

Border

(exp) The type of border around the text control.

Alignment

The alignment of the text.

Text

(exp) The displayed text.

 

                             Pointer

Property

Description

Pointer

(exp) The pointer image when it is over the text control.

 

                            HTML

Property

Description

Link

(exp) A URL that is the target of a link (HTML anchor element) generated for each data item in the column or for the specified control. The text or user-visible part of the link will be the data value in the column, the value of the computed field, the text in the Text control, or the image of a Picture control.

Link target

(exp) The name of a target frame or window for the hyperlink (HTML A element) specified in the Link property. The target is included using the TARGET attribute.You can use the LinkTarget property to direct the new page to a detail window or frame in a master/detail page design.If LinkTarget is null or an empty string (""), then no TARGET attribute is generated.

Link arguments

A string in the form:argname='exp'{ | argname = 'exp' } ...  Argname is a page parameter to be passed to the server.Exp is a DataWindow expression whose value is a string. It is evaluated and converted using URL encoding and included in the linkargs string.

Value is HTML

(does not apply to Picture controls) (exp) A boolean that, if true, allows the control contents (data value in a read-only column, the value of a computed field that is not calculated on the client, or the text in a Text control) to be generated as HTML. For XHTML, the control contents must be well-formed XHTML.

Append HTML syntax

HTML you want to append to the generated syntax for the rendering of a DataWindow control before the closing bracket of the HTML element for that control.

                             Position

Property

Description

X

(exp) The x coordinate of the text control.

Y

(exp) The y coordinate of the text control.

Width

(exp) The width of the text control.

Height

(exp) The height of the text control.

Layer

 

Slide up

(exp) How the text control moves up to fill empty space.

Slide left

(exp) Whether the text control moves left to fill space.

Moveable

Whether the user can move the text control.

Resizable

Whether the user can resize the text control.

Autosize height

Whether the control's height is adjusted to fit the data.

       Font

Property

Description

Face name

(exp) A string specifying the name of the font face, such as Arial or Courier.

Size

(exp) The font size.

Bold

(exp) Whether the text should be bold. The default is no.

Italic

(exp) Whether the text should be italic. The default is no.

Underline

(exp) Whether the text should be underlined. The default is no.

Strikethrough

(exp) Whether the text should be crossed out. The default is no.

Text color

(exp) The text color.

Background color

(exp) A long expression specifying the color (the red, green, and blue values) to be used as the control's background color.

Escapement

(exp) An integer specifying the rotation for the baseline of the text in tenths of a degree. For example, a value of 450 rotates the text 45 degrees. 0 is horizontal.

                             Special Action

Property

Description

Resize to fit text

Resizes the control so that its full text is displayed.

 

•      Column Control

General

Property

Description

Name

The name of the column.

Database column

The name of the database column.

Tab order

Has no effect.

Tag

(exp) The tag text for the column.

Hidesnaked

Whether the control appears once per page when printing newspaper columns.

Visible

(exp) Whether the column control is visible.

Border

(exp) The type of border around the column.

Alignment

(exp) The alignment of the column's text.

Display as picture

 

Protect

(exp) Whether the column is protected from changes.

Override edit

 

Equality required

 

Right to left

 

Pointer

Property

Description

Pointer

(exp) The pointer image when it is over the text control.

                     HTML

Property

Description

Link

(exp) A URL that is the target of a link (HTML anchor element) generated for each data item in the column or for the specified control. The text or user-visible part of the link will be the data value in the column, the value of the computed field, the text in the Text control, or the image of a Picture control.

Link target

(exp) The name of a target frame or window for the hyperlink (HTML A element) specified in the Link property. The target is included using the TARGET attribute.You can use the LinkTarget property to direct the new page to a detail window or frame in a master/detail page design.If LinkTarget is null or an empty string (""), then no TARGET attribute is generated.

Link arguments

A string in the form:argname='exp'{ | argname = 'exp' } ...  Argname is a page parameter to be passed to the server.Exp is a DataWindow expression whose value is a string. It is evaluated and converted using URL encoding and included in the linkargs string.

Value is HTML

(does not apply to Picture controls) (exp) A boolean that, if true, allows the control contents (data value in a read-only column, the value of a computed field that is not calculated on the client, or the text in a Text control) to be generated as HTML. For XHTML, the control contents must be well-formed XHTML.

Append HTML syntax

HTML you want to append to the generated syntax for the rendering of a DataWindow control before the closing bracket of the HTML element for that control.

                     Position

Property

Description

X

(exp) The x coordinate of the text control.

Y

(exp) The y coordinate of the text control.

Width

(exp) The width of the text control.

Height

(exp) The height of the text control.

Layer

 

Slide up

(exp) How the text control moves up to fill empty space.

Slide left

(exp) Whether the text control moves left to fill space.

Moveable

Whether the user can move the text control.

Resizable

Whether the user can resize the text control.

Autosize height

Whether the control's height is adjusted to fit the data.

Edit

Property

Description

Style type

(Describe only) Returns the edit style of the column.

Accelerator

(exp) The accelerator key for the column.

Format

(exp) A string containing the display format of the edit control. The value for Format is quoted and can be a DataWindow expression.

Case

The case of the text in the edit control. Values are:Any - Character of any case allowed. Upper - Characters converted to uppercase. Lower - Characters converted to lowercase.

Limit

A number specifying the maximum number of characters (0 to 32,767) that the user can enter. 0 means unlimited.

Auto selection

Whether to select the contents of the edit control automatically when it receives focus. Values are:Yes - Select automatically.No - Do not select automatically.You can use AutoSelect with SyntaxFromSQL. The setting applies to all the columns in the generated syntax.

Display only

Whether the column is display only. Values are: Yes - Do not allow the user to enter data; make the column display only. No - (Default) Allow the user to enter data.

Show focus rectangle

Whether a dotted rectangle (the focus rectangle) will surround the current row of the column when the column has focus. Values are: Yes - (Default) Display the focus rectangle. No - Do not display the focus rectangle.You can use FocusRectangle with SyntaxFromSQL. The setting applies to all the columns in the generated syntax.

Empty string is null

Whether to set the value of the edit control to null when the user leaves it blank. Values are: Yes - Make the Empty string null. No - Do not make the empty string null.

Password

Whether to assign secure display mode to the column. When the user enters characters, they display as asterisks (*). Values are: Yes - Assign secure display mode to the column. No - Do not assign secure-display mode to the column. If you change the Password property, you should also change the Format property to display the results you want (for example, *****).

Required

Whether the column is required. Values are: Yes - It is required. No - It is not required.

Auto horz scroll

Whether the edit control scrolls horizontally automatically when data is entered or deleted. Values are: Yes - Scroll horizontally automatically. No - Do not scroll horizontally automatically. You can use AutoHScroll with SyntaxFromSQL. The setting applies to all the columns in the generated syntax.

Auto vert scroll

Whether the edit box scrolls vertically automatically when data is entered or deleted. Values are: Yes - Scroll vertically automatically. No - Do not scroll vertically automatically.

Horz scrollbar

Whether a horizontal scroll bar displays in the edit control. Values are: Yes - Display the horizontal scroll bar. No - Do not display the horizontal scroll bar.

Vert scrollbar

Whether a vertical scroll bar displays in the line edit. Values are: Yes - Display vertical scroll bars. No - Do not display vertical scroll bars.

Use code table

Whether the column has a code table. Values are: Yes - Code table defined. No - No code table defined.

Validate

Whether the code table will be used to validate user-entered values. Values are: Yes - Use the code table. No - Do not use the code table.Painter: Validate option, available when Use Code Table is selected.

Font

Property

Description

Face name

(exp) A string specifying the name of the font face, such as Arial or Courier.

Size

(exp) The font size.

Bold

(exp) Whether the text should be bold. The default is no.

Italic

(exp) Whether the text should be italic. The default is no.

Underline

(exp) Whether the text should be underlined. The default is no.

Strikethrough

(exp) Whether the text should be crossed out. The default is no.

Text color

(exp) The text color.

Background color

(exp) A long expression specifying the color (the red, green, and blue values) to be used as the control's background color.

Escapement

(exp) An integer specifying the rotation for the baseline of the text in tenths of a degree. For example, a value of 450 rotates the text 45 degrees. 0 is horizontal.

Format

Property

Description

Format

(exp) The column's display format. Ex: If you want to add text to a numeric display format and use a color attribute, you must include the escape character (\) before each literal in the mask. Such as:  [red]\D\e\p\t\: ###

                             Special Action

Property

Description

Resize to fit the font

Resizes the control so that full text is displayed with the font size selected.

 

•      Computed Fields

General

Property

Description

Name

The name of the column.

Tag

(exp) The tag text for the text control.

Hidesnaked

Whether the control appears once per page when printing newspaper columns.

Visible

(exp) Whether the control is visible.

Border

(exp) The type of border around the text control.

Alignment

The alignment of the text.

Compute expression

The expression for the computed field.

Pointer

Property

Description

Pointer

(exp) The pointer image when it is over the text control.

HTML

Property

Description

Link

(exp) A URL that is the target of a link (HTML anchor element) generated for each data item in the column or for the specified control. The text or user-visible part of the link will be the data value in the column, the value of the computed field, the text in the Text control, or the image of a Picture control.

Link target

(exp) The name of a target frame or window for the hyperlink (HTML A element) specified in the Link property. The target is included using the TARGET attribute.You can use the LinkTarget property to direct the new page to a detail window or frame in a master/detail page design.If LinkTarget is null or an empty string (""), then no TARGET attribute is generated.

Link arguments

A string in the form:argname='exp'{ | argname = 'exp' } ...  Argname is a page parameter to be passed to the server.Exp is a DataWindow expression whose value is a string. It is evaluated and converted using URL encoding and included in the linkargs string.

Value is HTML

(does not appl