You are here: Home › Private: Version 6.5 › Private: XMPro Features › XMWorkspace Report Designer

XMWorkspace Report Designer

The purpose of the Report Designer wizard is to provide a fully integrated tool to create XMPro reports. DevExpress XtraReports are used to provide this functionality. Access the Report Designer from the XMWorkspace.

XMWorkspace

Open XMPro Report Designer

This procedure describes how to open the XMPro Report Designer.

XMWorkspace_ReportDesignerv6.5

  1. On the menu, click Manage > Report Designer in XMWorkspace. The XMPro Report Designer opens.

Create a New Report

A new report can be created by one of two methods as follows:

  • New (Empty) Report
  • New Report via Wizard

Create a New (Empty) Report

This procedure describes how to create a new (empty) report.

XMWorkspace_ReportDesigner_CreateEmptyReportv6.5

  1. Click XMWorkspace_ReportDesigner_NewReportIconv6.5 New Report icon (by default the report is named XtraReport).
  2. Type the report name into the New Report Name text field.
  3. Click OK.
  4. Click XMWorkspace_ReportDesigner_ToggleApplicationMenuIconv6.5 Application Menu.
  5. (Not shown) Click XMWorkspace_ReportDesigner_SaveReportIconv6.5 Save icon. The Empty Report is shown in the previous figure.

Choose a Data Source

This procedure describes how to choose data source to bind a report to a database. A data source must be selected before you can use the Report Wizard.

XMWorkspace_ChooseDataSource_Menuv6.5

  1. Click XMWorkspace_ReportDesigner_ToggleApplicationMenuIconv6.5 Application Menu.
  2. Click XMWorkspace_ReportDesigner_DataSourceEditorIconv6.5 Data Source Editor icon. The Report Datasource Editor opens.

XMWorkspace_ReportDesigner_ReportDatasourceEditor_AddDataSourcev6.5

  1. Click Add in the Report DataSource Editor. The Data Source Editor opens.

XMWorkspace_ReportDesigner_DataSourceEditor_AddDataSourcev6.5

  1. Select the relevant connection from the Connection drop-down in the Data Source Editor.
  2. Click Save.

XMWorkspace_ReportDesigner_ReportDataSourceEditor_AddQueriesv6.5

  1. Select the new Data Source in the Report DataSource Editor.
  2. Click Add in the Queries column of the Report DataSource Editor.

XMWorkspace_ReportDesigner_ReportDatasourceEditor_QueryEditorv6.5

  1. Select the relevant table from the list or type the name to search in the Query Editor.
  2. Click Save.

XMWorkspace_ReportDesigner_ReportDatasourceEditor_QueryEditor_Applyv6.5

  1. Click Apply in the Report DataSource Editor.

Create a Data-Bound Report – Database

This procedure describes how to use an SQL data source to bind a report to a database.

  1. Click XMWorkspace_ReportDesigner_ToggleApplicationMenuIconv6.5 Application Menu.
  2. Click XMWorkspace_ReportDesigner_RunWizardIconv6.5 Report Wizard icon and the Report Wizard opens.

XMWorkspace_ReportDesigner_ReportWizard_NoDataToDisplayv6.5

  1. Is there a Data Source available to use in your report?
    1. If YES, then continue with Step 4.
    2. If NO, then a data source must be provision using the Data Source Editor. Continue with Choose a Data Source.

XMWorkspace_ReportDesigner_CreateDataBaseData-BoundRepor_ChooseDataSourcev6.5

  1. Choose a Data Source from the list to use in your report.
  2. Click Next.

XMWorkspace_ReportDesigner_ReportWizard_ChooseTableOrViewv6.5

  1. Select a table or view to be available in your report.
  2. Click Next.

XMWorkspace_ReportDesigner_ReportWizard_ChooseColumnsToDisplayv6.5

  1. Select the columns that you want to display within in your report from the Available fields column.
  2. Click > to move the highlighted Available fields to the Selected fields column.
  3. Click Next.

XMWorkspace_ReportDesigner_ReportWizard_CreateGroupsv6.5

  1. Select the fields from the Available fields list to be grouped.
  2. Click > to move the highlighted Available fields to the Groups column.
  3. Click Next.

XMWorkspace_ReportDesigner_ReportWizard_ChooseColumnsReportLayoutv6.5

  1. Choose the Report Layout (Portrait or Landscape) for your report.
  2. Click the Report Layout Format (Stepped, Outline 1, Outline 2, Align Left 1, or Align Left 2)
  3. Select the Adjust the field width so all fields fit onto a page check box.
  4. Click Next.

XMWorkspace_ReportDesigner_ReportWizard_ChooseReportStylev6.5

  1. Choose a report style (Bold, Casual, Corporate, Compact, or Formal).
  2. Click Next.

XMWorkspace_ReportDesigner_ReportWizard_ChooseReportTitlev6.5

  1. Type the report title in the text field.
  2. Click Finish.
  3. Click Preview icon to preview the report.
  4. Click XMWorkspace_ReportDesigner_ToggleApplicationMenuIconv6.5 Application Menu and click XMWorkspace_ReportDesigner_SaveReportIconv6.5 Save icon to save the report.

Note: A report needs to be named before you can save the report.

XMPro Report Designer

User Report Controls

User report controls contain basic user functions, such as New Report, OpenReport, Delete Report, Download Report, Upload Report, and Refresh Reports. The following control types are available and listed as shown in the user interface from left to right.

Report Control Description
XMWorkspace_ReportDesigner_NewReportIconv6.5 New Report Displays a new report control that may be used to create a new report. Click to create a new empty report.
Open Report Displays an open report control that may be used to open a selected report. Click to open the selected report.
Delete Report Displays a delete report control that may be used to delete a selected report. Click to delete the selected report.
Download Report Displays a download report control that may be used to download the displayed report. Click to download a displayed report with an “.repx” extension.
Upload Report Displays an upload report control that may be used to upload a report that has an .repx file extension. Click to upload a report.
Refresh Reports Displays a refresh control that may be used to refresh the reports listed. Click to refresh the reports listed.
XMWorkspace_ReportDesigner_CollapseExpandIconv6.5 Collapse/Expand Displays a Collapse/Expand control. Click to collapse the listed reports or expand the listed reports.

Standard Controls

A report control is an element that is intended to display specific information in your report, such as static or dynamic text, pictures, a bar code, a check box, etc.

The following control types are listed alphabetically.

Report Control Description
Application Menu Displays an application menu control. Click to access to the following items:

  • Run Wizard – Click to run the report wizard
  • Save – Click to save the displayed report.
  • Data Source Editor – Click to add, edit, or delete report data sources.
Bar Code Displays a bar code control on the report that may be used to insert different bar code types.
Chart Displays a chart control on the report that may be used to represent data in a graphical view.
XMWorkspace_ReportDesigner_XRCheckBoxIconv6.5 Check Box Displays a standard check box control on the report that may be used to represent whether an item is selected or not.
Cross-Band Box Displays a box control on the report that draws itself through the bands from the CrossBandControl.StartPoint in the CrossBandControl.StartBand to the CrossBandControl.EndPoint in the CrossBandControl.EndBand.
Cross-Band Line Displays a line control on the report that draws itself through the bands from the CrossBandControl.StartPoint in the CrossBandControl.StartBand to the CrossBandControl.EndPoint in the CrossBandControl.EndBand.
Data Source Editor Displays a data source editor control that allows for adding, editing, or deleting report data sources. Click to add, edit, or delete report data sources.
Gauge Displays a gauge control on the report that imitates real-life gauges – circular, angular, linear, thermometer, digital, etc.
XMWorkspace_ReportDesigner_XRLabelIconv6.5 Label Displays a label control on the report that allows the insertion of single-line or multiline text. This text may be either static or dynamically populated from a report’s data source.
Line Displays a line control on the report that draws vertical, horizontal, or diagonal lines.
Page Break Displays a page break control on the report that serves to mark the place where a report should start a new page. To break a page just before or after a particular band, you can also use the Band.PageBreak property of this band, instead of using this control.
Page Info Displays a control on the report that displays some auxiliary information in a report. Use this control to display page numbers, the current date, or user information in your reports.
XMWorkspace_ReportDesigner_XRPanelIconv6.5 Panel Displays a panel control on the report that can contain other report controls. Use it to group controls together for easier manipulation.
Picture Box A picture box control that displays an image in a report. Use this control to insert images of different types in the reports.
XMWorkspace_ReportDesigner_XRPivotGridIconv6.5 Pivot Grid A pivot grid control (also called a pivot table) that represents data from an underlying data source in a cross-tabulated form to create crosstab reports.
XMWorkspace_ReportDesigner_XRRichTextIconv6.5 Rich Text Displays a rich text control on the report that is intended to display, enter and manipulate formatted text. Text can be entered and formatted at design time, loaded from an external file, or binded to a data field.
Run Wizard Displays a wizard control. Click to run the Reports Wizard.
Save Report Displays a save control. Click to save the report based on Report File format.
Shape Displays a shape control on the report that embeds simple graphics.
Sparkline Displays a sparkline control on the report that may be used to represent inline data in a graphical view.
Table Displays a rich text control on the report that is intended to display, enter and manipulate formatted text. Text can be entered and formatted at design time, loaded from an external file, or binded to a data field.
Zip Code Displays a zip code control on the report that allows the insertion of numbers representing a zip code.

Design Mode Report Controls

The design mode report controls are elements that are displayed when in the design mode. The following control types are listed alphabetically.

Report Control Description
XMWorkspace_ReportDesigner_CopyIconv6.5 Copy Displays a copy control on the report. Click to copy a selected item.
XMWorkspace_ReportDesigner_CutIconv6.5 Cut Displays a cut control on the report. Click to cut a selected item.
XMWorkspace_ReportDesigner_DeleteIconv6.5 Delete Displays a delete control on the report. Click to delete the selected item to the Recycle Bin.
XMWorkspace_ReportDesigner_FieldsIconv6.5 Fields Displays a field list control on the report. Click to display the field list associated with the report.
XMWorkspace_ReportDesigner_FullScreenIconv6.5 Full Screen Displays a full-screen control on the report. Click once to toggle the display from the current screen to full screen.
XMWorkspace_ReportDesigner_OpenExportOptionsIconv6.5 Open/Collapse Displays an open/collapse control on the report. Click to open or collapse the property grid controls.
XMWorkspace_ReportDesigner_PasteIconv6.5 Paste Displays a paste control on the report. Click to paste the recent item that was cut.
Preview Displays a preview control on the report. Click to preview the report. For more information, see Preview Mode Report Controls.
Properties Displays a properties control. Click to access the following properties:

  • Actions
  • Appearance
  • Behavior
  • Data
  • Design
  • Layout
  • Navigation
  • Styles


Note: Properties available are based on the selected object.

 
Redo Displays a Redo control on the report. Click to redo the previous action.
XMWorkspace_ReportDesigner_UnDoIconv6.5 Undo Displays an Undo control on the report. Click to undo the previous action.
XMWorkspace_ReportDesigner_ZoomControlIconv6.5 Zoom Control Displays a Zoom Control on the report. Click the drop-down menu to change the page magnification.
Zoom In Displays a Zoom In control on the report. Click the control to zoom in the page.
Zoom Out Displays a Zoom Out control on the report. Click the control to zoom out the of page.

Preview Mode Report Controls

The preview mode report controls are elements that are displayed when in the preview mode. The following control types are listed alphabetically.

Report Control Description
Design Displays a design control on the report. Click to return to report design mode.
First Page Displays a first page control on the report. Click to navigate to the first page.
Last Page Displays a last page control on the report. Click to navigate to the last page.
Multipage Mode Displays a multipage mode control on the report. Click to display multiple pages.
XMWorkspace_ReportDesigner_NextPageIconv6.5 Next Page Displays a next page control on the report. Click to navigate to the next page.
XMWorkspace_ReportDesigner_OpenExportOptionsIconv6.5 Open/Collapse Displays an open/collapse control on the report. Click to open or collapse the export options controls.
XMWorkspace_ReportDesigner_PageControlIconv6.5 Page Control Displays a page control on the report. Click to navigate to the selected page.
XMWorkspace_ReportDesigner_PropertiesIconv6.5 Export Options Displays an export options control on the report. Click to access the following Export Options:

  • CSV Export Options
  • HTML Export Options
  • IMAGE Export Options
  • MHT Export Options
  • PDF Export Options
  • RTF Export Options
  • TEXT Export Options
  • XLS Export Options
  • XLSX Export Options
XMWorkspace_ReportDesigner_PreviousPageIconv6.5 Previous Page Displays a previous page control on the report. Click to navigate to the previous page.
Save Preview Report Displays a save preview report menu control on the report. Click to save the previewed report in the selected file format to download. Based on the Export Control Options settings.
XMWorkspace_ReportDesigner_ZoomControlIconv6.5 Zoom Control Displays a Zoom Control on the report. Click the drop-down menu to change the page magnification.
Zoom In Displays a Zoom In control on the report. Click the control to zoom in the page.
Zoom Out Displays a Zoom Out control on the report. Click the control to zoom out the of page.

Add Report Controls

This procedure describes how to add controls to a report.

  1. To add report controls to your report, drag an appropriate item from the Standard Controls menu.
  2. Drop it on a report’s surface as indicated in the previous figure.
  3. Click XMWorkspace_ReportDesigner_PropertiesIconv6.5 Properties icon. The properties of this control are provided in the Property Grid window. Change as required.

XMWorkspace_ReportDesigner_AddReportControls_ToggleApplicationMenuv6.5

  1. Click XMWorkspace_ReportDesigner_ToggleApplicationMenuIconv6.5 Application Menu.
  2. Click XMWorkspace_ReportDesigner_SaveReportIconv6.5 Save icon.

Add Parameters

This procedure describes how to add parameters to a report.

XMWorkspace_ReportDesigner_AddParameters_FieldList1v6.5

  1. In Report Designer, click XMWorkspace_ReportDesigner_FieldsIconv6.5 Fields icon.
  2. Click the Parameters section.
  3. Click XMWorkspace_ReportDesigner_AddParameters_AddParametersIconv6.5 Add Parameter icon.

XMWorkspace_ReportDesigner_AddParameters_FieldList2v6.5

  1. Click xmd_BusinessGroups_XMWorkspace_CreateNewRoleGroup_SaveNewRecord_EditIcon icon to edit the parameter properties.
  2. Provide a name, description, visible, type, look-up settings for the parameter and optionally a default value.
  3. Click OK.
  4. Click XMWorkspace_ReportDesigner_ToggleApplicationMenuIconv6.5 Application Menu.
  5. Click XMWorkspace_ReportDesigner_SaveReportIconv6.5 Save icon.

Rebuild Report Dataset

This procedure describes how to change data sources for a report. When the underlying data source changes, the Data Set needs to be rebuilt as follows:

XMWorkspace_ReportDesigner_RebuildReportDatasetv6.5

  1. In Report Designer, click the Properties icon.
  2. Click DATA drop-down.
  3. Select a new Data Source from the Data Source drop-down.
  4. Select a new Data Member from the Data Member drop-down.

Open User Report

This procedure describes how to open a report in the XMWorkspace.

XMWorkspace_UserReportsv6.5

  1. From the XMWorkspace, click Insight > User Reports.
  2. Click the relevant report to view your design changes in the XMWorkspace, for example, Supplier List.

Report Toolbar and Controls

xmd_XMWorkspace_UserReports_PrintReportIconv6.5 Print report Click to print the current report.
xmd_XMWorkspace_UserReports_PrintCurrentPageIconv6.5 Print current page Click to print the current page.
xmd_XMWorkspace_UserReports_FirstPageIconv6.5 First page Click to navigate to the first page.
xmd_XMWorkspace_UserReports_PreviousPageIconv6.5 Previous page Click to navigate to the previous page.
xmd_XMWorkspace_UserReports_PageControlsIconv6.5 Page number Click to select the page number to display.
xmd_XMWorkspace_UserReports_NextPageIconv6.5 Next page Click to navigate to the next page.
xmd_XMWorkspace_UserReports_LastPageIconv6.5 Last page Click to navigate to the last page.
xmd_XMWorkspace_UserReports_ExportReportSaveIconv6.5 Export report & save Click to export the report and save it to a disk based on Report File Format.
xmd_XMWorkspace_UserReports_ExportReportShowIconv6.5 Export report & show Click to export the report and show it in a new window based on Report File Format.
xmd_XMWorkspace_UserReports_ReportFileFormatIconv6.5 Report file format Click to export the report as:

  • Comma Separated Values (CSV)
  • Excel Spreadsheet (XLS)
  • Hypertext Markup Language (HTML)
  • Office Open XML Spreadsheet (XLSX)
  • Portable Document Format (PDF)
  • Rich Text Format (RTF)
  • Web Archive (MHT)
xmd_XMWorkspace_UserReports_EmailIconv6.5 Email Click to email the PDF report using your default email client.
xmd_XMWorkspace_UserReports_OpenReportIconv6.5 Open Report Click to open the selected report.
xmd_XMWorkspace_UserReports_RefreshReportsIconv6.5 Refresh Reports Click to refresh the reports listed.

This is the legacy version of the XMPro Documentation site. For the latest XMPro documentation, please visit documentation.xmpro.com

Go to New Documentation Site
X