Scroll

Report Wizard: Categories

Select which data to use on the report. The left pane shows the data categories you can access. To see the fields in a category, select it, then click the View Category Fields Information.png icon.

What are data categories?

Data categories are tables of data, which are organized by rows and columns. Columns are also known as data fields. A row of data has entries for one or more columns in the category. When you add a data field onto a report you are seeing the information in one column of data for every row in the category.

For example, a data category for Employees could have columns for the first and last names of each employee, an identification number, and a home phone number. Each row represents a person, and each column contains a specific type of information such as Last Name or Phone Number.

custom.TableOfEmployees.png

Example of a data category for employee records

You add entire categories at a time to a report, but in the report view you select only the columns you want to see. When you add a data field to the report design, even though you only see one column, the rest of the table is still present behind the scenes. You will never lose the connections between items in each row, and you can always add more fields.

Adding categories

On the Categories page, add data categories to the report. Later on, you can select which fields you actually want to see in the report layout.

screen.reportwizard_drag_category.png

Dragging a category to the Category Name pane

Tip: As you add categories, unrelated categories will become unavailable.

SQL categories (advanced users)

Note: This feature is available in versions 2018.1 and above.

You may have the ability to define a custom data model for the report without needing to use the predefined data categories. For databases which support unique or unusual behaviors that are not supported in the main interface, you can use custom SQL to supplement or bypass the standard Categories, Sorts, Filters, and/or Joins. Only new reports, created with the Report Wizard, can have a custom SQL category. You cannot add a custom SQL category to an existing report.

Caution
Writing custom SQL requires knowledge of the underlying databases and their relevant SQL query language. It is only recommended for advanced users.

To add a custom SQL data category, click Add2.png Add SQL. From the Custom SQL Object window, add the following:

  1. Object Name - Unique name for the custom category. It cannot be the same as an existing category. It cannot contain white space or the following characters:

    [ ] { } . , @

  2. Data Source - Select the data source to retrieve the data from.

    Not every data source you can access may support custom SQL categories.

  3. Enter the full SQL statement in the code window. Note that this will be inserted into a subquery when it is sent to the database for processing.

    Optional: Parameters are system variables that contain different values depending on factors such as the person running the report. To include parameters in the SQL statement, select them from the Parameters list then click Add. Or enter the parameter name surrounded by At Signs (@).

    Tip
    A custom SQL category can only be the sole category on a report. A report cannot contain multiple custom SQL categories, or a mix of custom SQL and standard categories. Therefore, to include multiple tables on a report with custom SQL, you must retrieve multiple tables and join them in the SQL statement. If field names conflict, you can alias them in the SQL statement, or else the application will append a number to the end to preserve uniqueness.

    Click the Test Checkmark.png icon to check if the SQL is valid.

  4. When you have finished writing the SQL, click the Unique Key Fields list and select the unique keys for the category.

  5. Click Okay when done. If you have already sorted and filtered in the SQL statement, you can skip these menus.

Once added, you can edit the SQL category by clicking the SQL icon SQL.png next to its name in the Categories window.


Hidden Article Information

Article Author
Exago Development
created 2017-10-24 14:21:34 UTC
updated 2018-05-15 21:01:22 UTC

Labels
data, field, category, user, object, wizard,
Have more questions? Submit a request