In order to bring you the best possible user experience, this site uses Javascript. If you are seeing this message, it is likely that the Javascript option in your browser is disabled. For optimal viewing of this site, please ensure that Javascript is enabled for your browser.
Login  |   Cloud ERP  |   Home  |   qad.com



  •     QAD Glossary

  • Enhancing the Report with Fields
    To enhance your report, you can add fields (for example, lines, rectangles, labels, pictures, charts, and so on) to any section. You can also modify the existing fields by changing their properties with the Properties window, or move and resize the fields with the mouse.
    Creating Reporting Fields
    With the report definition loaded into Report Designer and a data source defined, you can add and edit report fields.
    You can bind three different types of data to the fields you add to a report:
    Fields: Values of fields that are bound to the source record set.
    Parameters: Values of search condition parameters under the Filter tab in Report Viewer.
    Report settings: Values of settings variables under the Settings tab in Report Viewer.
    The Report Designer toolbox allows you to easily add fields to your report.
    To add a field to your report
    1
    Click the Data tab in the Report Designer toolbox.
    2
    Click and expand a group to display all available data buttons. In the Data tab, the Fields and Parameters groups include fields for the report data source. The Report Settings group includes the following system settings:
     
    sys_base_currency
    The base currency (base_curr) from the underlying QAD Applications system.
    sys_batch
    Reserved for future use.
    sys_camnamespace
    Reserved for future use.
    sys_cbf_cacheflag
    Reserved for future use.
    sys_cbf_entity
    Reserved for future use.
    sys_cbf_instance_id
    Reserved for future use.
    sys_cbf_language
    Reserved for future use.
    sys_cbf_sessionid
    Reserved for future use.
    sys_ci_date_separator
    The character that separates the components of a date value. (For example, the backslash character: /). This is determined by the culture of the user ID running the report.
    sys_ci_decimal_digits
    The number of decimals places used for numeric values. This is determined by the culture of the user ID running the report.
    sys_ci_decimal_separator
    The character that represents the decimal point in a numeric value. This is determined by the culture of the user ID running the report.
    sys_ci_group_separator
    The character that separates groups of digits to the left of the decimal in numeric values. (For example, the comma in 1,000). This is determined by the culture of the user ID running the report.
    sys_ci_group_sizes
    The number of digits in each group of digits to the left of the decimal. This is determined by the culture of the user ID running the report.
    sys_ci_short_date_pattern
    The format of a short date value. This is determined by the culture of the user ID running the report.
    sys_client_email
    Reserved for future use.
    sys_default_report_definition
    The name of the report definition that is the default for the report resource.
    sys_domain
    The domain that the user is in while running the report.
    sys_email
    The e-mail address specified when the report is scheduled.
    sys_file_path
    Reserved for future use.
    sys_ips
    IP address of the client machine that is running the report.
    sys_language
    The ISO culture name in the format <languagecode> - <country/regioncode > (For example: en-US).
    sys_output_type
    Reserved for future use.
    sys_printer
    The printer that the report was sent to (only applies to reports scheduled to a printer).
    sys_render_as
    A numeric code that represents the output type:
    1=PDF
    2=Excel
    3=Document
    4=Text
    5=PDFProtected
    6=RTF
    7=TIFF
    sys_reportformat
    Reserved for future use.
    sys_report_template
    Reserved for future use.
    sys_run_at_server
    Reserved for future use.
    sys_schedule_type
    Reserved for future use.
    sys_search_criteria_display
    The position on the report at which the search criteria will be displayed. Values are Header, Footer, or None. These three values will be in English regardless of the language of the report. By default this parameter is set to Footer. You can force a specific search criteria location (see Adding Search Criteria Report Parameter).
    sys_trusted_signon_session
    The ID of the user that is running the report.
    3
    Click the field you want to add to the report; then move the mouse pointer over the report and the pointer changes into a cross-hair.
    4
    Click and drag to define the rectangle that the new field will occupy, and then release the button to create the new field.
    If you change your mind, press Ctrl+Z or click the Undo button to cancel the operation.
    You can also add fields by copying and pasting existing fields, or by holding down the CTRL key and dragging a field or group of fields to a new position to create a copy.
    Manipulating and Formatting Fields
    You can use the mouse to select fields in Report Designer as usual:
    Click a field to select it.
    Shift-click a field to toggle its selected state.
    Ctrl-drag creates a copy of the selected fields.
    Click the empty area and drag your mouse pointer to select multiple fields.
    With your mouse pointer, drag field corners to resize fields.
    Double-click right or bottom field corners to auto size the field.
    To select fields that intersect vertical or horizontal regions of the report, click and drag the mouse on the rulers along the edges of the Designer. If fields are small or close together, it may be easier to select them by name. You can select fields and sections by picking them from the drop-down list above the Properties window.
    Format Fields
    When multiple fields are selected, you can use the buttons on the Format toolbar to align, resize, and space them. When you click any of these buttons, the last field in the selection is used as a reference and the settings are applied to the remaining fields in the selection.
    Apply Styles
    The Brush button applies the style of the reference field to the entire selection. The style of a field includes all font, color, line, alignment, and margin properties. You can use the Properties window to set the value of individual properties to the entire selection.
    Determine Order For Overlapping Fields
    If some fields overlap, you can control their z-order using the Bring to Front/Send to Back buttons. This determines which fields are rendered before (behind) the others.
    Move Fields Using the Keyboard
    You can also select and move fields using the keyboard:
    Use the TAB key to select the next field.
    Use SHIFT-TAB to select the previous field.
    Use the arrow keys to move the selection one pixel at a time (or shift arrow to move by five pixels).
    Use the DELETE key to delete the selected fields.
    When a single field is selected, you can type into it to set the Text property.
    Changing Field, Section, and Report Properties
    Once an object is selected, you can use the Properties window to edit its properties.
    When one or more fields are selected, the Properties window shows property values that all fields have in common, and leaves the other properties blank. If no fields are selected and you click on a section (or on the bar above a section), the Section properties are displayed. If you click the gray area in the background, the Report properties are displayed.
    To see how this works, click the label in the Header section and change its Font and ForeColor properties. You can also change a field’s position and dimensions by typing new values for the Left, Top, Width, and Height properties.
    The Properties window expresses all measurements in twips (the native unit used by Report Designer), but you can type in values in other units (in, cm, mm, pix, pt) and they will be automatically converted into twips. For example, if you set the field’s Height property to 0.5 inches, the Properties window will convert it into 720 twips.
    A twip (derived from TWentieth of an Imperial Point) is a typographical measurement, defined as 1/20 of a typographical point. One twip is 1/1440 inch or 17.639 µm when derived from the PostScript point at 72 to the inch, and 1/1445.4 inch or 17.573 µm based on the printer’s point at 72.27 to the inch.
    Field Object Settings
    Section Object Settings
     
    Category
    Setting
    Description
    Appearance
    Align
    Specifies how text is aligned within the field. Click on the field and select icons for Left Top, Center Top, Right Top, Justify Top, Left Middle, Center Middle, Right Middle, Justify Middle, Left Bottom, Center Bottom, Right Bottom, and Justify Bottom.
    BackColor
    Select the background color from the Custom, Web, or System tabs.
    Font
    Specify the font, font style, size, script, and effects such as strikeout and underline.
    Font Color
    Select the foreground color from the Custom, Web, or System tabs.
    Format
    Specify the format of the field value, including number, date, and time formats.
    Margins
    Specify the Bottom, Left, Right, and Top margin settings.
    Text
    Specify the text string of the field. For further information on formatting and translated labels, see Using Translated Labels.
    TextDirection
    Specify the direction of the text within the field.
    WordWarp
    Specifies whether the text will wrap within the field area.
    Border
    BorderColor
    Specifies the border color of the field.
    BorderStyle
    Specifies the field’s border style as Transparent, Solid, Dash, Dot, DashDot, or DashDotDot.
    LineWidth
    Specifies the width of a field’s border (or line).
    Data
    Text
    Specifies the field’s text or corresponding database identifier for the field data.
    Design
    (Name)
    Specifies the system field name.
    Visible
    Specifies whether the field is visible on the report (True or False).
    Layout
    Anchor
    Specifies the vertical position of the field area relative to its containing section as Top, Bottom, or Top and Bottom.
    Bounds
    Specifies the Height, Left, Top, and Width bounds of the field area.
    CanGrow
    Specifies whether to increase the field height to fit the field automatically (True or False).
    CanShrink
    Specifies whether to decrease the field height to fit the field automatically (True or False).
    ForcePageBreak
    Specifies when to insert page breaks. Select None, Before, After, BeforeAndAfter, PageBefore, and PageAfter.
    KeepTogether
    Specifies whether the field area should be kept together on the same page (True or False).
    ZOrder
    Specifies the layering priority of the field area when two or more fields overlap. The higher the number, the higher the priority.
    Template
    Class
    Specifies the class of the field inherited from the template for the report.
    Section Object Settings

    Section Object Settings
     
    Category
    Setting
    Description
    Appearance
    BackColor
    Specifies the section’s background color. Click on the field and select a color from the pull-down menu.
    Design
    (Name)
    Specifies the name that identifies the section.
    Visible
    Specifies whether the section will be rendered when the report is run (True or False).
    Layout
    CanGrow
    Specifies whether to increase the section height to fit the content automatically.
    CanShrink
    Specifies whether to decrease the section height to fit the content automatically.
    ForcePageBreak
    Specifies when to insert page breaks. Select None, Before, After, BeforeAndAfter, PageBefore, and PageAfter.
    Height
    Specifies the section height in twips.
    KeepTogether
    Specifies whether the section should be kept together on a page (True or False).
    Repeat
    Specifies whether the section should be repeated (True or False).
    Script
    OnFormat
    Enter a Visual Basic script that will be executed during the formatting stage of report rendering.
    OnPrint
    Enter a Visual Basic script that will be executed in the final stage of rendering, after all report field values have been filled.
    Template
    Class
    Specifies the class of the section inherited from the template for the report. For example, classes can include Detail, Header, Footer, PageHeader, and PageFooter.
    Report Object Settings

    Report Object Settings
     
    Category
    Setting
    Description
    Behaviour
    DoEvents
    Specifies whether to handle messages while rendering reports (True or False).
    ExposeScriptObjects
    Specifies whether script objects should be exposed to subreports (True or False).
    GrowShrinkMode
    Specifies the method used to process the CanGrow and CanShrink settings.
    IgnoreCase
    Specifies case-insensitivity when grouping by a field (True or False).
    IgnoreScriptErrors
    Specifies whether to ignore script errors (True or False).
    MaxPages
    Specifies the maximum number of pages to render.
    UsePrinterResolution
    Specifies whether to use .NET printing support.
    Layout
    ColumnLayout
    Specifies the layout for the columns as Down, Across, or Labels.
     
    Columns
    Specifies the number of detail columns.
    CustomHeight
    Specifies the custom height for the report in twips. Use this property only if you have set PaperSize to Custom.
    CustomWidth
    Specifies the custom width for the report in twips. Use this property only if you have set PaperSize to Custom.
    LabelSpacingX
    Discounts horizontal label spacing in the design surface.
    LabelSpacingY
    Discounts vertical label spacing in the design surface.
    MarginBottom
    Specifies the bottom margin for each page in twips.
    MarginLeft
    Specifies the left margin for each page in twips.
    MarginRight
    Specifies the right margin for each page in twips.
    MarginTop
    Specifies the top margin for each page in twips.
    Orientation
    Specifies the page orientation as Auto, Portrait, or Landscape.
    PageFooter
    Specifes the page footer as AllPages, NotWithReportHdr, NotWithReportFtr, or NotWithReportHdrFtr.
    PageHeader
    Specifies the page header as AllPages, NotWithReportHdr, NotWithReportFtr, or NotWithReportHdrFtr.
    PaperSize
    Specifies the paper size to one of a wide variety of settings, including:
    Letter
    LetterSmall
    Tabloid
    Ledger
    Statement
    Executive
    A3
    A4
    A4Small
    A5
    B4
    B5
    Folio
    Quatro
    Standard10x14
    Standard11x17
    The Custom option allows you to define your height and width where needed. If you specify Custom, you must also specify the CustomHeight and CustomWidth properties.
    For more information, see Paper Size Configuration Guidelines.
     
    Picture
    Specifies a background picture for the report body. Click on the field to browse to and select an image file.
    PictureAlign
    Specifies how the background picture is aligned. Select from the icons that indicate the positioning relative to the page area.
    PictureScale
    Specify the picture scaling method as Clip, Stretch, Scale, Tile, or Hide.
    PictureShow
    Specifies where the background picture is displayed. Select NoPages, AllPages, FirstPages, or AllButFirstPage.
    Width
    Specifies the width of the report’s detail section in twips. For more information, see Paper Size Configuration Guidelines
    Script
    OnClose
    Enter a Visual Basic script that will be executed when the report finishes rendering.
     
    OnError
    Enter a Visual Basic script that will be executed when an error occurs.
    OnNoData
    Enter a Visual Basic script that will be executed when the report has no data.
    OnOpen
    Enter a Visual Basic script that will be executed when the report starts rendering.
    OnPage
    Enter a Visual Basic script that will be executed each time a new page is created.
    Paper Size Configuration Guidelines
    Several settings must be set properly when configuring the desired width for a report. It is a good idea to specify these properly before spending time designing the detailed layout of fields because incorrect width settings can sometimes require moving and resizing fields to correct width problems.
    To start, determine the paper size that the report is targeted for, and set the PaperSize report property (see Report Object Settings) accordingly. Next, set the margin properties, which are in units of twips (1/1440 of an inch). The margins are blank in the output, so the actual width available for use in placing report fields and other objects is determined by the paper width minus the left and right margins.
    The ruler at the top of the designer has a light-colored segment whose width is equal to the available width (paper width minus right and left margins). This represents the actual region that can contain fields for this paper and margin size.
    The next thing to set is the Width property, which can be set either numerically in the property grid or by clicking and dragging the mouse on the right edge of the light-colored canvas rectangle in the designer’s main pane. It is recommended to set the Width after the Paper Size and margins are set, and to make the width line up exactly with the ruler width that reflects the paper size and margins. If this is not done, and the Width is set larger than the ruler width, then truncation will likely occur in the printed output when the report is run.
    After the Paper Size, Margins, and Width are set up properly, the report is ready for detailed work to put the fields and other objects onto the desired locations on the page. The light-colored canvas region represents the usable area (since the margins have already been accounted for), so fields can be placed right up to the very edge of this region and they will not be truncated or bleed into the margins.
    Note: The Width property does not have any direct effect on the actual size of the report output. The output size is determined solely by the paper size setting. The Width is mostly used to visually set the canvas background so that the developer can see the available region to place fields in without truncation.
    Note: The system will not allow the Width property to be set smaller than needed to fit the fields that are currently on the report page. If a smaller width is desired, the fields must be moved or resized to allow the Width to be reduced.
    Changing the Data Source
    1
    In Report Designer, right-click a report under the Reports tab in the toolbox; then select Data Source from the shortcut menu.
    2
    The Select Data Source dialog box displays. Click to select the table you want to set as the new data source; then click OK.
    3
    The data source is changed. When you switch to the Data tab in the toolbox, you can see a new set of data-bound fields.
    Note: When you select a new data source, any field associated with the old data source becomes invalid and will not display data in the report.
    Controlling the Maximum Number of Records Per Report Page
    You can control the maximum number of records to display on each page of a report by using the page break control.
    In Report Designer, place the page break control beneath the data fields on the report; then in the Properties pane, specify the value of its RecordsPerPage property. During report rendering, when the number of records on a page reaches the maximum number of records allowed, the remaining records go to subsequent pages.
    Note: The records-per-page property does not apply to reports in the Excel format. All records are displayed continuously in an Excel report.
    Note: A report contains subreports and when the records in a subreport reaches the maximum number per page allowed, the report page breaks even when the parent report has not reached the records per page limit.
    Using Translated Labels
    You can design reports that can be readily localized into multiple languages. When localized, the system dynamically reads the label master table to determine the appropriate labels to display on your reports. This table contains translated labels that can be specified with a string that specifies the desired label (the label term key, for example “SALES_ORDER”). A report design can use these label term keys so that when the report is run, the system will retrieve the translated label in the appropriate language for the user.
    If you attempt to translate a label that does not exist in the label master, you should create a record for it using Label Master Maintenance (36.4.17.24) so that the label can be translated and maintained.
    For Label report fields, the value of the Text property will typically be literally displayed in the field when the report is rendered. However, the system can be instructed to automatically select translated labels when the report is rendered. This mode of operation is triggered when the Text property contains a value with the special ${ LABEL_TERM } format, which instructs the system to look up the translated label corresponding to the LABEL_TERM used.
    System labels can have short, medium, and long versions, of which the system intelligently selects the largest that will fit into the report field, taking into account factors such as field width and font size. For example, if the field width is not large enough to display the large label for the given text in the given font, the medium label will be displayed automatically if it fits.
    Note that the Reporting Framework is flexible about the format of the label terms. For example, you can enter the term for Sales Order as ${SALES_ORDER} or ${Sales Order}. The system will replace spaces with underscores and perform case-sensitive matching at run-time.
    There are also some variations on this format that allow you to explicitly specify which label should be used:
    ${TERM}S — specifies the short label
    ${TERM}M — specifies the medium label
    ${TERM}L — specifies the long label
    ${TERM}! — specifies a stacked label
    Note that in the case of stacked labels, the height of the field must be large enough to fit all the levels in the stacked label or the display of the label will be truncated.
    For Calculated fields, the value of the Text property is evaluated as a VBScript expression and the result will be displayed in the field when the report is rendered. One special case is when the expression consists of the name of a report data field, in which case the value of that data field will be displayed when the report is rendered.
    For Calculated fields, you can also specify to have integers converted into the words for the number. For instance, you can have “12” displayed as “twelve.” The format is as follows:
    ${TERM}N — specifies integer to words conversion
    For logical values and value lists, you can specify to have the value rather than the label display:
    ${TERM}V — specifies the value rather than the label