XMDesigner 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 XMDesignerIs used to configure XMPro BPM solutions., Wizards tab, Report Designer.

XMDesigner

Open XMPro Report Designer

This procedure describes how to open the XMPro Report Designer using the XMDesigner.

If the Report Designer is grayed out, contact your Site Administrator.

1. On the ribbon, click the Wizards tab, click Report Designer from the Reporting Group in XMDesigner. The XMPro Report Designer opens.

Create a New Report

This procedure describes how to create a report in the XMPro Report Designer.

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

• New Report [Blank]
• New Report via Wizard

These options are available from the New Report menu on the Report Designer tab.

Create a New Report via Wizard

This procedure describes how to create a new report via the wizard in the XMPro Report Designer.

1. Click the New Report drop-down from the Report Designer tab.
2. Click New Report via Wizard option from the Report Designer tab.
3. (Not shown) Select the relevant report from the Report Wizard. For example, Empty Report, Data-bound Report, or Label Report. Go to the relevant procedures below.

Create an Empty Report

This procedure describes how to create an empty report via the wizard in the XMPro Report Designer.

1. Click Empty Report (by default the report is named XtraReport).
2. Click Finish. The Empty Report opens as shown in the following figure.

Create a Data-Bound Report – Database

This procedure describes how to use an SQL data source to bind a report to a database in the XMPro Report Designer.

1. Click Data-bound Report from the Report Wizard.
2. Click Next.

3. Click the Database data source type from the Report Wizard.
4. Click Next.

5. Specify whether you want to use an existing data connection or create a new data connection. Click No, I’d like to specify the connection parameters myself or Yes, let me choose an existing connection from the list radio button.
6. Click Next.

Note: Cannot connect to the database. See the details below. A network related or instance-specific error occurred while establishing a connection to SQL Server. The server was not found or was not accessible. Verify that the instance name is correct and that the SQL Server is configured to allow remote connections. (provider: SQL Network Interfaces, error: 26 – Error Locating Server/Instance Specified).

7. Define a custom connection string, or select from the supported data source types. Depending on the data provider selected, it may be necessary to specify additional connection options (such as authentication type and database name) on this page.
8. Click Next.
9. Select the data provider and specify the connection properties.
10. Click Finish.
11. On the ribbon, click the Print Preview tab to view the report in the Report Designer or to view the report in XMWorkspace, see Deploy a Report in XMDesigner.

Create a Data-Bound Report – Entity Framework

This procedure describes how to connect to an Entity Framework data source defined from an external assembly containing the required context.

1. Click Data-bound Report from the Report Wizard.
2. Click Next.

3. Click the Entity Framework data source type from the Report Wizard.
4. Click Next.

5. Select an existing data context from the list or browse for an assembly.
6. Click Next.

Note: You can also use an external assembly containing the required context. To do this, click the Browse and locate the required assembly. Select the required data context from this assembly and click Next.

7. On the final page, choose the connection string corresponding to the selected data context and click Finish.

If the application configuration file does not contain the required connection string, or you need to specify the connection string manually, select No, specify a custom connection string and click Next.

NEED NEW SCREENSHOT FROM GAVIN

8. On this page, specify a custom connection string and click Finish. This creates the data source and displays its fields in the Field List.
9. (Not shown) On the ribbon, click the File tab, click Save or press CTRL+S to save your changes.
10. On the ribbon, click the Print Preview tab to view the report in the Report Designer or to view the report in XMWorspkace, see Deploy a Report in XMDesigner.

Create a Data-Bound Report – Object Binding

This procedure describes how to connect to an object data source defined in a separate class.

1. Click Data-bound Report from the Report Wizard.
2. Click Next.

3. Click Object Binding from the Report Wizard.
4. Click Next.

5. Select the assembly containing the class type definition of a data source from the Report Wizard.
6. Click Next.

For instance, this can be a custom class providing the required data or any TableAdapter used to query a database.

7. Select a data source type.
8. Click Next.

9. Select a data binding mode (Retrieve the data source schema or Retrieve the actual data).
10. Click Next.

11. Select the columns you want to display in your report. Click the relevant fields in the Available fields list.
12. Click > to add to the Fields to display in a report field.
13. Click Next.

14. Create multiple groups, each with a single field value, or define several fields in the same group. Click the relevant fields in the Available fields list.
15. Click > to add to the Fields to display in a report.
16. Click Next.

17. Click the relevant report layout (Portrait or Landscape).
18. Click the relevant report arrangement, for example, Stepped, Outline 1, Outline 2, Align Left 1, or Align Left 2.
19. Click Adjust the field width so all fields fit onto a page check box.
20. Click Next.

21. Click a report style that specifies the appearance of your report, for example, Bold, Casual, Corporate, Compact, or Formal.
22. Click Next.

23. Enter the report title.
24. Click Finish.
25. (Not shown) On the ribbon, click the File tab, click Save or press CTRL+S to save your changes.
26. (Not shown) On the ribbon, click the Print Preview tab to view the report in the Report Designer or to view the report in XMWorspkace, see Deploy a Report in XMDesigner.

Create a Label Report

This procedure describes how to create a label report in XMDesigner.

1. Click Label Report from the Report Wizard.
2. Click Next.
3. Select the relevant Label product from the drop-down.
4. Select the relevant Product Number from the drop-down.
5. Click Next.

6. Click the Label’s parameters to adjust, if required.
7. Click Page Size to change the page size of your report, if required.
8. Click Finish.
9. (Not shown) On the ribbon, click the File tab, click Save or press CTRL+S to save your changes.
10. On the ribbon, click the Print Preview tab to view report in the Report Designer.
11. To view report in XMWorspkace, see Deploy a Report in XMDesigner.

XMPro Report Designer

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 available:

Report Control		Description
	Bar Code	A bar code control allows you to insert many different bar code types into a report.
	Chart	A chart control that may be used to represent data in a graphical view.
	Check Box	A check box control that may be used to represent whether an item is selected or not.
	Cross-Band Box	A box control 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	A line control that draws itself through the bands from the CrossBandControl.StartPoint in the CrossBandControl.StartBand to the CrossBandControl.EndPoint in the CrossBandControl.EndBand.
	Label	A label control that allows the inserting of single-line or multiline text into a report. Note that this text may be either static or dynamically populated from a report’s data source.
	Line	A line control that draws vertical, horizontal, or diagonal lines in a report.
	Page Break	A page break control 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	A control that displays some auxiliary information in a report. Use this control to display page numbers, the current date, or user information in your reports.
	Panel	A panel control 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 your reports.
	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.
	Pointer	A pointer control that allows interaction with a form to move items around or to select focus.
	Rich Text	A rich text control that is intended to display, enter and manipulate formatted text. You can enter and format its text at design time, load it from an external file, or bind this control to a data field.
	Shape	A shape control that embeds simple graphics in a report.
	Sparkline	A sparkline control that may be used to represent inline data in a graphical view.
	Sub-Report	A sub-report control that is used to insert one report into another. For example, this control can be used when a sub-report contains certain template information that must be used in other reports. A Subreport control is also intended to create master-detail reports. For more information on how this can be done, refer to the Subreport topic.
	Table	A rich text control that is intended to display, enter and manipulate formatted text. You can enter and format its text at design time, load it from an external file, or bind this control to a data field.
	Table Of Contents	A table of contents control that reflects the hierarchy of the report’s bookmarks.  It can only be added into a report header band.
	Zip Code	A zip code control that allows the insertion of numbers representing a zip code into a report.

Add Report Controls

This procedure describes how to add report controls in the XMPro Report Designer.

1. Drag an appropriate item from the Standard Controls menu tab.
2. Drop it on a report’s surface as indicated in the previous figure.
3. Click the Report Explorer. The properties of this control are provided in the Property Grid window. Change as required.

Add Parameters

This procedure describes how to add parameters to a report in the XMPro Report Designer.

1. (Not shown) In the Report Designer, click Field List tab.
2. Right-click the Parameters section and select Add Parameter.

3. Provide a name and type for the parameter and optionally a default value.
4. Click OK.
5. (Not shown) On the ribbon, click the Report Designer tab, click Save or press CTRL+S to save your changes.

Parameters can be appended to the Report Link URL in the ActivityA specific step in a process.  It will be the user interface for that step (web form or a screen), for example, the Leave Application (screen interface or web form) will be the first Activity in the Leave Requisition process.  The Leave Application Authorization will be the second step or Activity in the Leave Requisition process.  One Process can have multiple activities., but this must be done using a script.

Display a Report in XMDesigner

This procedure describes how to display a report in XMDesigner.

1. Access the Fast Field Editor by double-clicking the Reference Label control.
2. Remove the Width setting.
3. Remove the Caption.
4. Give it a relevant name.
5. Drag a new Reference Label control onto the activity.
6. In XMDesigner, open the particular Activity you would like to display the report on.
7. Check the OnLoad box under the Behaviour section.
8. Select the Report Link radio button.
9. Enter the Report Name (this should match the name of the report setting created earlier).
10. Set Width to 100%.
11. Select the database connection to use.

Deploy a Report in XMDesigner

This procedure describes how to deploy a report in XMDesigner.

The following prerequisites must be met to deploy a report.

Prerequisites

• Create an Activity from the XMDesigner.
• Configure the properties using the Activity Configuration Wizard.
• Right-click the Activity and select XMPro Wizard.
• Ensure that the Static field contains the Report: keyword. For example, Report: Loan Application Dashboard.
• Configure the Routing Type and Routing Group.
• Click Advanced tab.
• Select the Trigger Style.
• Click OK.
• On the ribbon, click the File tab, click Save or press CTRL+S to save your changes.

1. On the ribbon, click the Settings tab in XMDesigner.
2. On the ribbon, click Reports in the Custom Settings group. The customSettings\XMPro\Reports directory displays a list of existing Reports.
3. Click Setting and provide the values as follows:
   • Name: This should match the filename of the report file but should exclude the “.repx” extension. e.g., For a report file SalesReport.repx, the setting should be SalesReport
   • Value: This should contain the full physical path to the report file including the “.repx” extension
   • Type: This should be set to “value”
4. On the ribbon, click the File tab, click Save or press CTRL+S to save your changes.

Rebuild Report Dataset

This procedure describes how to rebuild the report dataset in the XMPro Report Designer.

When the underlying data source changes, the Data Set needs to be rebuilt as follows:

1. In Report Designer, delete the existing Dataset and Table Adaptor.
2. Open the Data Source drop-down from the Property Grid and select Add New DataSource.
3. Run the Report Wizard and configure the data source.

Once the data set has been rebuilt the new or changed fields can be added to the report.

Existing fields should not need any changing unless the underlying dataset field names have been changed.

XMWorkspace

Open Report

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

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

	Print report	Click to print the current report.
	Print current page	Click to print the current page.
	First page	Click to navigate to the first page.
	Previous page	Click to navigate to the previous page.
	Page number	Click to select the page number to display.
	Next page	Click to navigate to the next page.
	Last page	Click to navigate to the last page.
	Export report & save	Click to export the report and save it to a disk based on Report File Format.
	Export report & show	Click to export the report and show it in a new window based on Report File Format.
	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)
	Email	Click to email the PDF report using your default email client.
	Open Report	Click to open the selected report.
	Refresh Reports	Click to refresh the reports listed.