Reports are built with the Report Builder application.
General
Throughout the report, follow these Nextworld text best practices:
| Field | Value |
|---|---|
| Report Font | Plex Sans |
| Font Size | 12px or 10px |
| Text Color | Black—RGBA(0, 0, 0, 1) or Hex (#000000) |
The content labels you use should come from data item labels instead of constants. If someone changes the label of a synonym, it appears across applications and reports consistently.
The height and width of the report must align with dimensions for letter or legal paper format dimensions.
Do not create colon (:) content labels. For example, if you may have the label Supplier and the label ABC Supplier in a report. Do not link the labels with a constant (:) content label to create Supplier : ABC Supplier.
Always apply a sort in Report Builder if you want records in the report output to display in a particular order. If you are expecting data to be returned from a table in the order that it was added by a logic block, apply a sort in Report Builder on the nwCreatedDate field.
Report Title
Repeat the header on each page. To create pixel perfect reports, or reports in which you can control every component of the report down to the pixel level, the header must not repeat.
The report title must be Bold and follow the standards of the other report parameters in Report Title such as company, fiscal year, period, as-of date, etc for a financial report. These standards are:
| Field | Value |
|---|---|
| Style | Horizontal Align Center, Vertical Align Bottom |
| Font Size | 16px |
Column field labels
Place column field labels in the Detail section under Sections. Column field labels must follow these standards:
| Field | Value |
|---|---|
| Style | Bold, Horizontal Align Center, Vertical Align Bottom |
| Border Bottom | Size 2, Solid |
| Border Top | Size 2, Solid |
Group Header fields
| Field | Value |
|---|---|
| Style | Bold, Horizontal Align Left |
Totals
Sub totals and grand totals in a report must be added to the Group Footer section. Sub total text must have a Style of Horizontal Align Left. Sub total numbers and amounts must be aligned under their appropriate column.
Line Separators
Line separators between rows and sub totals must be placed in the Detail or Group sections. Use separate lines if your detail line layers multiple fields or if you have a group total. If your detail line fields are only on one row, then do not use line a separator.
| Field | Value |
|---|---|
| Border Bottom | Size 1, Solid |
Data Items
| Data item type | Style |
|---|---|
| Currency | Horizontal Align Right |
| Date | Horizontal Align Center |
| Number | Horizontal Align Right |
Page Footer and Last Page Footer
Both the Page Footer and the Last Page Footer sections must contain the information on when the report was run and display the report page numbers.
The data item you use to display when the report was last run must be configured according to the following:
| Field | Value |
|---|---|
| Type | System |
| System | Current Date and Time or Current Date |
| Style | Horizontal Align Left |
The data item you use to display the report page numbers must be configured according to the following:
| Field | Value |
|---|---|
| Type | System |
| System | Page Number or Page Number of Count |
| Style | Horizontal Align Right |
No Data
By default, if no data is found when a report runs, Nextworld displays a default message. Select the Use Custom No Data check box if you want to display specific content instead of the default.
Watermark
If you use a watermark in your report, you must use either a System or Input Type.
Indexes
Add a unique index to your report table that contains the ReportVersion data item. This prevents users from creating multiple versions of a report with the same Report Version value and ensures that jobs that run the report run the intended version.
When you apply a sort in Report Builder, add indexes for the fields you are sorting with to improve performance.
When building a report over a flat table, create a primary index on the table for the ReportExecutionID data item. This improves performance. You should also ensure that the Use NATE container checkbox is cleared on your logic block that flattens the data.
Report application standards
Build a Report Version application over a Report Builder record. The Report Version application is the tool that end users use to input their specific parameters for the report.
Configure these standards in the Application Builder application for a report type application.
Pages and Rows
You must define at least two rows to be used in the detail form. You can add more rows depending on the specific report version application requirements. Only use pages if multiple pages are necessary.
The different rows must be configured as such in the Rows subtable:
| Field | Top row | Second row | Subsequent rows |
|---|---|---|---|
| Title | No title | Report Parameters | No title |
| Collapsible | False | False | False |
| Hide Row Separator | True | False | False |
List Form Fields
The list form of a report version application is only displayed if the report version application is immediately accessed through the list view. If the report version application opens directly to the detail form, users cannot access the list form.
The order of the list form Primary fields must always begin with ReportVersion. If it is displayed in the detail form, then ReportTitle should be the next Primary field visible.
The list form Primary fields should follow this order of precedence:
ReportVersionReportTitleReportLayout- Date and DateTime fields
OrganizationalUnit- Additional parameter fields (these must not be Date, DateTime or True False fields)
- True False fields
After you include the above, you must also include the ReportDisplay field as Available-Hidden.
Detail Form Fields
The top row should only contain the following fields in the Detail Form Fields page:
ReportDisplayReportVersionReportTitleReportLayout
The second row must contain selection criteria specific to the type of report. For example, the second row could contain work order selection criteria or item ledger summary selection criteria.
Report naming conventions and standards
These naming standards ensure that reports across Nextworld follow the same conventions so that application developers can easily identify and classify them.
Do not use the word Report in the report name because it is added on to the table and application names. Format the report objects according to the conventions listed below:
| Nextworld object | Naming convention | Example |
|---|---|---|
| Report | <Report name> | SalesOrder |
| Sub Report | <Report name><Sub report>Subreport | SalesOrderSubreport or WOTravelerOperationsSubreport |
| Report table | <Report name>Report | SalesOrderReport |
| Report version application | <Report name>Report | SalesOrderReport |
Flat tables
When you are building a report over a flat table, you must create some additional objects to the standard report building process that is mentioned above. Format the flat report objects according to the conventions listed below:
| Nextworld object | Naming convention | Example |
|---|---|---|
| Flat table | <Report name>Flat <Report name><Subreport>Flat | SalesOrderFlat WOTravelerOperationsFlat |
| Logic block | <Flat table name>Execution | SalesOrderFlatExecution |