How to create a custom report

What you can do

Build your own CRIBWISE report – a table or one of seven chart types – by dragging fields from a reporting data source into the report designer. The report is saved next to the built-in reports, and you open, filter, export and schedule it like any other report.

How a custom report comes together in CRIBWISE: 1 name the report and pick its data source and report type, locked at the first save; 2 drag fields into the zones; 3 narrow the data on the Filters tab; 4 save and test run, after which the report is listed with the built-in reports


Before you start

  • Your user group needs the Create privilege for Report. Changing a report later needs Update, and removing it needs Delete. The privileges are set per user group under Administration > Group management > AP Privileges > Entity Privileges – see Admin Portal permissions reference.
  • Decide which data source the report reads. The data source decides which fields you can use, and which of them can be grouped or summed. See Report data sources reference.
  • Decide the report type: a table, or a pie, column, bar, line or combined chart. See What each report type looks like.

Important: The data source and the report type are locked at the first Save. To change either one later, create a new report.

Tip: A built-in report can be a quicker start. Open it and select Copy report – see Copy the report before you change it.


Quick start

Experienced users – create a report in 4 steps:

  1. Go to Reports > Report viewer and select New report.
  2. Enter a Name, choose the DataSource and the Report type, then select Save.
  3. Drag fields from Available fields into the zones on the right.
  4. Select Save, then Test run.

Need more detail? Follow the full steps below.


Steps

The steps build an example table report, Transactions per device, on Raw transactions data. A chart report is built the same way, with different zones.

Step 1 — Start a new report

  1. In the main menu, select Reports > Report viewer.
  2. Select New report above the list of reports.

The Report panel opens on the Report definition tab. The Filters and Scheduler tabs and Test run stay greyed out until the report has been saved once.

New report form in the CRIBWISE Admin Portal: (1) New report above the list of reports, (2) the Name, DataSource and Report type fields, (3) the Save button

(1) New report, (2) the three fields to fill before the first save, (3) Save.

Step 2 — Name the report and choose its data

  1. In Name, type a name for the report. It must be different from every other report, built-in reports included.
  2. In DataSource, choose the data the report reads: Assignment (inventory, restock) data, Raw transactions data, Orders data, Stock history data or Stock locations data.
  3. In Report type, choose the report type.
  4. Select Save.

The message The Report [name] has been successfully saved appears. The designer now shows the fields of the data source under Available fields, and a set of drop zones for the report type. DataSource and Report type are greyed out from now on.

Report designer after the first save: (1) the saved message, (2) DataSource and Report type greyed out, (3) Filter fields and the Available fields list, (4) the Group by, Columns and Values zones of a table report

(1) The report is saved, (2) data source and report type are now locked, (3) the fields of the data source, (4) the drop zones – here the three zones of a table.

Report type Zones in the designer Use it to
Table Group by, Columns, Values List rows, optionally grouped, with totals.
Pie chart Categories, Value Show each category’s share of a total.
Column chart Categories, Value, Series Compare categories side by side.
Stack column chart Categories, Value, Series Compare category totals, each split into its parts.
Bar chart Categories, Value, Series The column chart turned on its side – easier to read with long category names.
Stack bar chart Categories, Value, Series The stacked column chart turned on its side.
Line chart Categories, Value, Series Follow a value over time, one line per series.
Combined chart Categories, Value, Value 2 Compare two values for the same categories, as columns and a line.

Step 3 — Drag fields into the zones

  1. In Filter fields, type part of a field name to shorten the list – for example device.
  2. Drag the field from the list onto a zone.
  3. Repeat for every field the report needs.

A field you drop is added at the top of the zone and disappears from Available fields. The report shows the fields in the order they have in the zone. To take a field out again, drag it back onto the field list.

Table report designer with (1) Device name in Group by, (2) Timestamp and Item ID in Columns, (3) Value and Quantity in Values, and (4) Test run now available

The example report: (1) rows grouped by Device name, (2) Timestamp and Item ID as plain columns, (3) Value and Quantity summed per device, (4) Test run is available as soon as a zone holds a field.

Zone Report types What it does
Group by Table Groups the rows by this field. Each group can be collapsed and expanded in the report, and shows the totals of the Values fields.
Columns Table Plain columns, one value per row – even when rows repeat the same value.
Values Table Number fields that are summed per group. A grand total is shown at the bottom of the report.
Categories All charts The field the chart is drawn per: the slices of a pie, the columns or bars, the points of a line. Takes one field. Required.
Value All charts The number that is summed per category. Takes one field. Required.
Series Column, bar and line charts, stacked or not Splits each category by a second field – one colour, or one line, per value. Optional.
Value 2 Combined chart A second number, drawn as a line on its own axis. Required.

Note: Only fields that can be summed – such as Quantity, Consumed quantity, Value or Usage cost – can go into Values, Value and Value 2. Text fields, dates and IDs are refused. The Values column in Report data sources reference lists which fields qualify.

Step 4 — Sort and slice the data (optional)

Every field in a zone has a Sort by icon. Fields in Values or Value also have a Slice by icon (a funnel).

Zones of a column chart report with Vendor name, Consumed quantity and Item type: (1) the Sort by icon on Vendor name, (2) the Slice by funnel icon on Consumed quantity

The zones of a column chart, with the preview sketch above them: (1) Sort by, (2) Slice by.

  • Sort by – select it once to sort ascending, again for descending, and a third time to stop sorting on that field. Only one field sorts the report at a time: sorting another field turns the first one off. The icon of the active sort is darker.
  • Slice by – shows only the highest or lowest records by that value. It opens Data slice settings: choose Top or Bottom in Show only, type the number of records in Values, then select Set. To remove the slice again, open it and select Clear filter.

Data slice settings panel for Consumed quantity: (1) Show only Top and 5 Values, (2) Set, (3) Clear filter

Data slice settings: (1) show only the top 5 records, (2) Set applies the slice, (3) Clear filter removes it.

Step 5 — Set the filters (optional)

Open the Filters tab to limit what the report reads – a time period, transaction types, devices and so on. These filters apply every time the report is opened or sent. See How to use report filters.

Important: With Raw transactions data, filter on transaction type to get meaningful totals. Total consumption, for example, needs the Pick, Return and Scrap transactions only.

Step 6 — Save and test the report

  1. Select Save.
  2. Select Test run.

Test run also saves the definition, then opens the report next to the designer. There you can check the result and go back to the designer to adjust it.

Test run of the Transactions per device table report: (1) Collapse all, Expand all and Export, (2) the rows grouped under Device1, (3) Advanced filter

The example report in a test run: (1) the toolbar of a test run, (2) rows grouped per device with the values summed, grand totals at the bottom, (3) Advanced filter.

A test run has a limited toolbar: Collapse all, Expand all, Export and Advanced filter for a table, and Export and Advanced filter for a chart. Edit report, Copy report and Pin to dashboard appear only when you open the report from the list.

Success: The report is in the list of reports. Select it and select View detail to open it with the full toolbar.


What each report type looks like

Every chart below was built on Raw transactions data, with Consumed quantity as the value.

Pie chart

Categories Item type, Value Consumed quantity. Each slice is one category.

Pie chart report showing consumed quantity per item type: Consumable, Durable and (empty)

Column chart

Categories Vendor name, Series Item type, Value Consumed quantity. The series stand side by side within each category.

Column chart report showing consumed quantity per vendor, with one column per item type

Stack column chart

The same fields as the column chart. The series are stacked, so the height of a column is the category total.

Stacked column chart report showing consumed quantity per vendor, stacked by item type

Bar chart

The same fields again, with the categories on the vertical axis.

Bar chart report showing consumed quantity per vendor as horizontal bars, one per item type

Stack bar chart

The stacked version of the bar chart.

Stacked bar chart report showing consumed quantity per vendor as horizontal bars stacked by item type

Line chart

Categories Year-Month, Series Vendor name, Value Consumed quantity. One line per vendor, month by month. A time field such as Year-Month, Week or Year suits the categories of a line chart.

Line chart report showing consumed quantity per month, one line per vendor

Combined chart

Categories Item type, Value Consumed quantity, Value 2 Value. Value is drawn as columns on the left axis, Value 2 as a line on the right axis.

Combined chart report showing consumed quantity as columns and consumed value as a line, per item type


Change or delete a custom report

  • Change it – select the report in the list, select View detail, then Edit report. You can change the name, the fields, the filters and the schedule, but not the data source or the report type.
  • Delete it – select the report in the list and select Delete report. Answer Yes to Do you really want to delete the report [name]?

Warning: Closing the designer with unsaved changes asks There are unsaved changes, do you really want to leave this page and lose all the changes you made? Select No and save first – Yes discards the changes.


Next steps

  1. Schedule it – send the report by email or to an FTP server on a fixed schedule. See Schedule automatic sending.
  2. Pin it to the dashboard – show the report as a widget on the home page. See How to configure dashboard widgets.

Troubleshooting

Problem Likely cause Fix
Report name is not unique when you select Save. Another report, built-in or custom, already has that name. Choose a different name.
Save does nothing and a zone is outlined in red. A required chart zone is empty: Categories, Value, or Value 2 on a combined chart. Drag a field into the outlined zone, then save.
There are no fields and no zones to drag them to. The new report has not been saved yet. Fill in Name, DataSource and Report type, then select Save.
Test run is greyed out. No zone holds a field yet. Drag at least one field into a zone.
A field will not drop into Values, Value or Value 2. Only fields that can be summed are accepted there. Use a number field. Check the Values column in Report data sources reference.
A field is missing from Available fields. It is already in a zone, or Filter fields still holds text. Look in the zones, or clear Filter fields.
DataSource and Report type are greyed out. Both are locked at the first save. Create a new report with the data source and type you need.
Edit report and Copy report are missing. The report is open in a test run, which has a limited toolbar. Close it, then open the report from the list with View detail.

Was this article helpful?

Related Articles