Table Setup

Note For simplicity, we use "table" in the following description to refer to any of database object in the project. A database object can be either a table, a view, a Custom View or a report.

After loading the database, the tables will be shown in the database pane on the left pane. To access ALL setting for a table (including Table-specific Options), click the table node of any table in the database pane and then click the [Table] tab to go to the Table Setup page. This is the setup page for a single table.

You can also click on the [Tables] or [Views] or [Custom Views] or [Reports] node in the database pane to go to the Tables Setup page which is a grid showing the most frequently used settings for all tables. If you need to set these settings for multiple tables, this page allow you to view and set them quickly. Note that this page does not include Table-specific Options.

The Table Setup pages consists of two section. The upper section is a grid showing available options of all tables. The lower section contain two panels, the [Table-specific Options] panel and the [Report Settings] panel for the selected table.

screen shot

Note For all checkbox or combobox columns, if you want to apply the setting to ALL tables or views, you can choose your setting at the [Tables] or [Views] or [Custom Views] or [Reports] row.

If you prefer to view the tables in alphabetical order, click [Tools]->[Sort Tables Alphabetically] (see Tools).

You can still change the display order of the menu item by drag-and-drop. Select a table by clicking the first column - [Table Name] column, then drag and drop to where you want. Note that a table cannot be moved out of its parent node.

Note that changing the display order of table in this Table Setup page does not change the display order of the tables in the menu. To change the display order of the menu item, click [Tools]->[Menu Editor] (see Tools).

The available table level settings are as follows:

Generate	Select/unselect a particular table for generation
Caption	To change the caption of a table, click on [Caption] box to make the necessary change. Note If you use Multi-Language (see PHP Settings), use Multi-Language Property Editor, see Tools for details.
Filter	Specify a filter (WHERE clause) for the table. Click the [...] button in [Filter] column, the Filter Editor will popup. Enter your filter, you can drag the field names from the left pane to the editor, the SQL identifier quote characters will also be added for you automatically. Note The filter must be a valid PHP string as the WHERE clause will be concatenated to the SQL string.
Sort	Specify the sort fields (ORDER BY clause) for the table. Click the [...] button in [Sort] column, the following dialog box will popup. You can choose up to 6 fields, in either ascending or descending order.
Default	Set a Table as the Default Table. The Default table is the first table the user see when visiting your site. Select the table you want in the [Default] column.
Export page size	Specifies the number of groups (or records if no grouping field) in each page of the exported document (page breaks will be inserted between pages). Default is 0, i.e. disabled, no page breaks. If you enter n (where n > 0), there will a page break inserted every n groups/records. Notes Does not work with exporting to Excel by HTML. However, it is supported by PhpSpreadsheet extension (for registered users), see Third-Party Tools. If the data for each page is too large for one physical page, it may still span more than one page before starting a new page.
Requires search criteria	Specifies if the report requires search criteria (filtering). Default is disabled. Note If enabled, the report always requires search criteria. When the page is initially loaded, no records will be displayed until searching is done. (Remember to enable Filter or Extended Filter or both)
Fields per row (Extended Filters)	Specifies the number of fields per row in the Extended Filter panel. Default is 0 (unspecified), one field per row.

Table-specific Options

Same as the list page options as described in PHP Setup except that the options are table-specific, meaning you can have different list page options for different tables. To use table-specific options, select a table in the grid, uncheck [Use global settings] in the [Table-specific Options] panel, the panel will be enabled for you to setup.

Report Settings

Show report	Show both report data (in HTML table) and charts (if any). If you want the report to show charts only, uncheck this setting.
Include row sums	Includes row sums for the crosstab report Note For use with Crosstab reports only
Include detail	If checked, records belonged to each grouping level will be displayed under the grouping level title, then followed by the summary. If unchecked, the details records are skipped, only the summary will be displayed. Note NOT applicable to Crosstab reports.
Show page summary	If checked, the summary for the records in the current page will be displayed at the end of the page.
Show grand summary	If checked, the summary for all the records in the report will be displayed at the end of the page.
Show compact summary view	If checked, the summary will be displayed as columns for each group. The the details records are not displayed. If unchecked, the summary are displayed at the bottom of each group. Note NOT applicable to Crosstab reports.
Show compact summary footer	If checked, the summary footer for each grouping levels will be displayed in a single row instead of multiple rows. Note NOT applicable to Crosstab reports.
Show grouping levels as rows	If checked, the grouping levels will be displayed as rows instead of columns. Note NOT applicable to Crosstab reports.
Generate reports by HTTP GET/POST	If checked, user is allowed to generate URL for accessing reports to save them on server or send them by email. For example, you can use the URL to create a Cron job or scheduled task on your server to make periodical report snapshots. The report enabled with this feature will have a button at the top of the report. User can click the button to open a Generate Report URL form, generate the URL and copy the URL to clipboard for your own use. The form inputs are: Report type - Same as the allowed export types of the report User name - The username used to log in the website and process the report. If the current user is Administrator or a Parent User (see Security Settings), the user can choose a child user to generate reports for him/her. Filter name - None (no filter), or Current (current filter), or one of the saved filters of the report Pages - Either First page or All pages. If First page only, the page size will be same as the report's Records per page setting (see above and PHP Settings). Notes All pages are NOT recommended, especially if your report is large or report types includes PDF because it will require a lot of memory and the export may fail. If you want to hide the option All, you can use Client Script (see example in Server Events and Client Scripts). This setting is independent of the Export type setting (Current page or All pages) of the report. Response type - JSON or File. If JSON, the URL will return a JSON object with a property url containing the full URL of the generated report saved on server. Your client accessing the URL can parse the JSON object to get the URL. If File, the URL will output the report directly, your client should handle the outputted report itself. By default the report will not be saved on server. Note For BOTH JSON and File, if report type is Email, the report will be sent by email, the URL will only return a JSON object like {"url":"Email sent successfully"}. The phrase "Email sent successfully" can be customized in language files. Show filters - If checked, the generated report will show the filters of the report. URL - The read-only generated URL. Press Generate button to generate and show the report URL, then press Copy to clipboard button to copy the URL for your own use. Notes A report snapshot is a report that contains query results that were retrieved at a specific point in time. Unlike on-demand reports, which get up-to-date query results when you select the report, report snapshots are processed and then saved to the server. The report snapshots will be saved in the File folder, see PHP Settings -> General Options. By creating a series of report snapshots, you can build a history of a report that shows how data changes over time. If you prefer to have a report history table logging the information of the report snapshots, you can create one by clicking Tools -> Create report history table. The table has an user name field, by default the user name will be logged, but if User ID Security (see Security Settings) is enabled, User ID will be logged instead. You can enable User ID Security for the report history table so that users can only view their own reports. By default the generated URL is for HTTP GET. If you have a lot of filters the URL may become too long, then you need to detach the URL parameters from the URL and use HTTP POST to pass the parameters to the server.