Report Designer

Create custom WO reports

69 views 25 January, 2017 25 February, 2019 Valuekeep 0

Valuekeep allows you to create and customize entity reports using the Report Designer tool. In this section we show you how to customize a WO’s operational report. The following articles describe the process of creating and customizing a report:

  1. How to create a new report based on the WO’s operational report?
  2. How to add a field to the data source of the WO’s operational report?
  3. How to add details to the data source of the WO’s operational report?
  4. How to add a field to the WO’s operational report?
  5. How to add route fields to the WO’s operational report?
  6. How to translate the WO’s operational report?
  7. How to preview changes of the WO’s operational report?
  8. Example 1 – Adding Asset and WO fields to the WO’s operational report.
  9. Example 2 – Adding details of the labor reports to the WO’s operational report.
  10. Example 3 – Adding attachments of image type to the report

 

You can read DevExpress’ documentation to learn more about Report Designer and how to use the tool’s options.

Note: due to customizations and the evolution of this tool into new versions made by their developers, some of the items described in the documentation may not match what is available in Valuekeep.

Report Designer: https://documentation.devexpress.com/#XtraReports/CustomDocument17545

Preview: https://documentation.devexpress.com/#XtraReports/CustomDocument17554

How to create a new report based on the WO's operational report?

Is it possible to customize the WO’s operational report? To do this, you will use the Report Designer tool.

To customize the report, follow these steps:

  1. Access the “Entity Report Uploads” option;
  2. Filter the list by the “Work Order” entity using the quick filter (Description column);
  3. Edit the record that matches the “Work Order” entity;
  4. In the “Report Definitions” grid, click the operational report’s “Edit” link;
  5. In the window to duplicate the report, enter the new name and description and click “Save”;
  6. Edit the report and select “Save” from the Report Designer’s options menu.
You can set the new report as the default in the “Report Definitions” grid.

How to add a field to the data source of the WO's operational report?

In addition to the fields already available in the report, you can add other fields from WO or related entities. The selectable fields are available from the report’s data source.

To add fields to the data source of the WO’s operational report, follow these steps:

  1. From the Report Designer menu, select “Edit Source Data” to open the source data editing wizard;
  2. Click the button on the right of the “WorkOrders” entity and select “Configure”;
  3. Click the name of the entity to which you want to add the field and place a checkmark in the fields to be added to your data source;
  4. When you are finished adding fields, click “OK” and then “Save”.
Save the report before editing the data source to avoid losing your changes.

If the field matches an associated entity that is not yet part of the report’s data source, it will appear at the bottom of the list and you must select at least one of its fields.

To remove fields from the data source, follow the same steps and remove the checkmark from the fields you want to remove.

How to add details to the data source of the WO's operational report?

You can add details of the WO to the report, in a “master/detail” connection. The examples already available in the base report are the details of plans and tasks.

To add details to the WO operational report, follow these steps:

  1. From the Report Designer menu, select “Edit Source Data” to open the source data editing wizard;
  2. Click the button on the right of the “WorkOrders” entity and select “Add detail table”;
  3. Search for the desired entity and click “Add”.
  4. The detail entity is added at the bottom of the entities list. Click the menu on the right and select “Configure”;
  5. Specify the connection between the main and the detail entities;
  6. Select the fields you want to be available in the report from the columns list. Click “OK” and then “Save”.

An entry is created on the detail report with two bands: header and detail. The fields or information regarding all detail records must be placed in the header band. The fields or information regarding each detail record must be placed in the detail band.

Save the report before editing the data source to avoid losing your changes.
To remove details from the data source, follow the same steps and select “Remove this”.

How to add a field to the WO's operational report?

You can add other fields of the WO to the operation report, from both related entities and details. The fields that can be selected are those available in the report’s data source.

To add fields to the WO operational report, follow these steps:

  1. In Report Designer, select the “Fields” tab on the right side of the screen;
  2. Expand the “WorkOrders” data source and then the “WorkOrder” table;
  3. Go to the desired related entity and drag the field to the report area;
  4. Specify the field’s size and position;
  5. If you want to add a label to the field, drag a “XRLabel” control type from the toolbar on the left side of the screen. Place the label next to the field;
  6. To configure the label’s text, double-click it or specify it in the label’s properties (tab on the right side of the screen).
The WO and related entity fields must be added inside the “Detail” band. Detail entities must be added inside the corresponding detail band.
The report’s data source is the “WorkOrders” table, so you must always add fields located inside this table in the explorer.
In the properties tab you can specify several formatting options for the field, such as the font, color, border or size.

How to add route fields to the WO's operational report?

To add fields from the routes to the WO operational report, follow these steps:

  1. Select “Edit Data Source” from the Report Designer menu.
  2. Select configure from the “AssetRouteCompositions” or “LocationRouteCompositions” detail tables menu;
  3. Select which fields will be added using a checkmark;
  4. Click OK and then Save;
  5. Drag the new fields from the fields explorer to the report;
  6. Preview and save your changes.

How to translate the WO's operational report?

You can specify text labels in several languages. For this you will need to use the texts specified in the product, for example – values used in the entity view. This is the rule for generating text resource keys for entity fields:

RES_LBL_<Entity>_<Field>_Description

Example: WO date field

RES_LBL_WorkOrder_Date_Description

To specify labels in several languages for the WO operational report, follow these steps:

  1. Select the report (from the Report Explorer on right side or by clicking on the drawing area, outside the report borders);
  2. Select the “Properties” tab on the right side of the screen;
  3. Expand the “Data” option and introduce this value in the “Tag” field:
    1. Primavera.MaintenanceManagementCore.Resources.Resources, Primavera.MaintenanceManagementCore.Resources, Version=1.0.0.0, Culture=neutral, PublicKeyToken=33086db60a481256
  4. Select a label;
  5. Select the “Properties” tab on the right side of the screen;
  6. Expand the “Data” option and introduce the text resource key in the “Tag” field;
  7. Repeat this process for the report’s remaining labels.
To validate translations, print the report with a user configured with the desired language.

How to preview changes of the WO's operational report?

To validate changes to the report, you can preview it during the editing process. To preview it, follow these steps:

  1. Select the “Preview” option from the Report Designer’s top menu;
  2. Navigate the report using the options in the top menu;
  3. To go back to editing click “Design”.
To increase performance and speed in the design of reports, preview displays a maximum of 50 records.

Example 1 – Adding Asset and WO fields to the WO's operational report.

This complete example demonstrates how to create a new report and add fields from the WO entity and related entities:

Creating a new report

  1. In the Entity Record Loading option, edit the WO operational report;
  2. Enter the new report’s name and description. Click “Save”.

Specify the data source

  1. In the menu, click “Edit Data Source”;
  2. From the “WorkOrders” entity menu, select “Configure”;
  3. Click “WorkOrders” to expand the column list;
  4. Place a checkmark in the “Created By” column;
  5. Click “WorkOrders” again to close the column list;
  6. Click “Assets” to expand the column list;
  7. Place a checkmark in the “IsUptime” column;
  8. Click “Assets” again to close the column list;
  9. Click “OK” and then “Save”;
  10. From the Report Designer menu, click “Save”.

Adding fields

  1. From the tabs on the right side of the screen, select “Fields”;
  2. Expand the “WorkOrders” data source and then the “WorkOrders” table;
  3. Drag the “Created By” field into the “Detail” band. Place it, for example, next to the WO state;
  4. Expand the “Assets_AssetId” table under the “WorkOrders” table;
  5. Drag the “IsUptime” field into the “AssetData” band. Place it, for example, next to the relevance;
  6. With the “IsUptime” field selected in the report, click the “Properties” tab on the right side of the screen and place the “IsAvailable” value in the Text property;
  7. From top menu, click “Preview” to validate your changes;
  8. From the Report Designer menu, click “Save”.

Example 2 - Adding details of the labor reports to the WO's operational report.

This complete example demonstrates how to create a new report and add details of labor reports (date and document key):

Creating a new report

  1. In the Entity Record Loading option, edit the WO operational report;
  2. Enter the report’s name and description. Click “Save”.

Specify the data source

  1. In the menu, click “Edit Data Source”;
  2. From the “WorkOrders” entity menu, select “Configure”;
  3. Click “WorkOrders” to expand the column list;
  4. Remove the checkmark from the “Failure” column;
  5. Click “OK”.
  6. Click the button on the right of the “WorkOrderPlans” and “FailureTypifications” entities and select “Remove this”;
  7. Click “Save”;
  8. From the Report Designer menu, click “Save”.

Removing details

  1. Select the report explorer tab on the right side of the screen;
  2. Expand the report and select the “MaintenanceManagementCore.FailureTypifications” band;
  3. Remove this band;
  4. Select the “MaintenanceManagementCore.WorkOrderPlans” band;
  5. Remove this band;
  6. From the Report Designer menu, click “Save”.

Adding details

  1. In the menu, click “Edit Data Source”;
  2. From the “WorkOrders” entity menu select “Add detail table”;
  3. Select the “WorkOrderReportLabors” table and click “Add”.
  4. In the “WorkOrderReportLabors” entity menu, select “Configure”;
  5. On the connection, select the “Id” column for the WorkOrders entity and “WorkOrder” for the WorkOrderReportLabors entity;
  6. Click the WorkOrderReportLabors entity to expand the column list;
  7. Place a checkmark in the “ReportDate” and “SequenceKey” columns;
  8. Click “OK” and then “Save”;
  9. From the Report Designer menu, click “Save”.

Adding fields

  1. From the tabs on the right side of the screen, select “Fields”;
  2. Expand the “WorkOrders” data source and then the “WorkOrders” table;
  3. Expand the “WorkOrderReportLabors” table;
  4. Drag the “ReportDate” and “SequenceKey” fields into the new “Detail1” band;
  5. Drag “XRLabel” controls from the menu on the left, place them next to the fields and change the text to correctly identify these fields;
  6. From the top menu, click “Preview” to validate your changes;
  7. From the Report Designer menu, click “Save”.

Example 3 - Adding attachments of image type to the report

You can specify whether the JPEG or PNG WO attachment files are available for printing. These images can be added to the custom report following these steps:

  1. Edit the report’s data source;
  2. Add a details table to the WorkOrders table;
  3. Choose the EntityImageAttachments table;
  4. Configure the table connection, selecting the Id field from the WorkOrders table and the EntityId field from the EntityImageAttachments table;
  5. Select some fields from the EntityImageAttachments table, including the Buffer field;
  6. Confirm;
  7. Add an Image type control in the details band created and configure the data connection to use the Buffer field;
  8. Save the report
To ensure that the report is printed without any errors or performance issues, we recommend using a maximum of 20 images for each report.

Foi útil?