Tile Builder
This program lets you create and maintain business insight tiles.
Things you can do in this program include:
-
Create a new business insight tile
-
Create a new business insight tile from an existing tile
-
Maintain the tile summary and tile detail
-
Preview the business insight tile before deploying it
-
Delete a business insight tile
Exploring
This program can't be run standalone and is accessed from the following program(s):
-
Insight Tile Definition
From the New Tile function or by selecting an existing tile.
SYSPRO Business Activity Queries are SQL views that are created in the relevant company databases and (because they are defined in SYSPRO) are recognized as data sources. They provide a view into the business data commonly used during the typical business management process. The queries are built and secured in the core ERP system and then surfaced to users via their enterprise reporting and connectivity solutions.
Business insight tiles (also called insight tiles or just tiles) are essentially SQL scripts displayed in a tile format within a SYSPRO web view. These tiles are context-driven and let you act instantly on events, facilitating informed business decisions and sound business behavior.
KPIs on tiles can be used to highlight values approaching or exceeding pre-determined objectives or thresholds. This lets you proactively keep an eye on approaching targets. These targets could be a certain value, company-wide goal or a specific target agreed for a person or a role within the organization.
In the context of SYSPRO Business insight tiles and SYSPRO Business Activity Queries, a data source can be considered as one of the following:
-
SYSPRO base table (e.g. InvMaster)
-
SYSPRO custom form table (e.g. InvMaster+)
-
SYSPRO Business View
-
User defined base table (i.e. any base table in the current database that is not part of the standard SYSPRO database)
-
User defined custom form table (i.e. any base table defined with a trailing + sign that doesn't form part of the standard custom table definitions)
-
User defined views (i.e. any view in the company database that is not defined as a SYSPRO Business View)
Starting
You restrict operator access to activities within a program using the Operator Maintenance program.
Controls whether an operator can edit VBScripts or change customized panes.
It also controls whether an operator can access the Visual Designer program (displayed from the sub menu of the icon).
This does not apply to importing customized panes, which is controlled by the Allow to import customized panes activity.
You can restrict operator access to programs by assigning them to groups and applying access control against the group (configured using the Operator Groups program).
-
Tile definition file names must end with .SQL and can only include the characters A-Z, a-z, 0-9 and _ (underscore).
Solving
In SYSPRO 7 Update 1 and SYSPRO 8 standard tiles are shipped in the \Base\Samples folder and custom tiles are designed to be located in \Plugin\CustomStore folder.
Some custom tiles may have been created by copying and renaming existing tiles in \Base\Samples folder instead of moving the custom tile to the \Plugin\CustomStore folder.
During the minor database upgrade to SYSPRO 8 2021 R2 (or later) these non-standard tiles are detected and automatically migrated to the \Plugin\CustomStore folder with the appropriate file prefix. Standard tiles located in \Base\Samples and custom tiles in \Plugin\CustomStore are also uploaded to the new system-wide AdmTileDefinition table.
In addition, once each custom tile has been uploaded to SQL, the custom tile definition files in \Plugin\CustomStore are moved to the \Plugin\CustomStore\Tile_Backup folder.
If any problems are found during the tile upload process, the tile definition file is moved to the \Plugin\CustomStore\Tile_Backup_Upload_Failed folder. An explanation of the failure is stored in a separate file with the file suffix _Upload_Failed_Reason.TXT.
-
Select the Design Web View (or Edit Web View) option from the Customize and control this application icon ().
This icon is available on the toolbar of the main SYSPRO window, as well as on each SYSPRO program's toolbar.
-
From the Visual Designer program, select the Add layout section function.
-
From the Configure new layout section window, select Tile Section.
-
Optionally enter a Section title at the Widget title placeholder and assign an icon to the tile if required.
-
Select the Add section function.
-
Click in the Add tile block (designated by the icon).
A list of KPI and Metric categories are displayed.
The number of available insights are indicated by a number in brackets alongside each tile category.
-
Drill down into the relevant category and select the tile you want to deploy.
-
(Optional) Define the following for the tile:
-
Width
-
Text
-
Tile background color
-
Icon
-
-
Select the Add tile function to assign the tile to the current layout section.
Continue adding tiles to the current layout section or to a new layout section.
-
Select Save and Exit.
Your tile will be displayed in the web view, immediately showing the appropriate insight information.
-
Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).
-
Select the New Tile function to create a custom tile.
The Tile Builder program is launched:
-
Enter the tile details within the New Tile window.
-
Select the Edit Tile Summary function.
You can also manually edit the SQL statement by selecting the Edit Tile Detail button.
The Tile Builder - SQL Definition program is displayed:
-
Select the Select data source function at the Primary data source field in the From section to indicate the anchor data source. The Data Sources program is displayed.
-
Highlight the relevant table from the Data Sources list view and click on Select.
Once you have selected the data source it is displayed in square brackets next to the Primary data source field in the Tile Builder - SQL Definition program.
-
Select the Validate SQL and Close function to exit the Tile Builder - SQL Definition program.
-
-
Select the Save and Close function to exit the Tile Builder program.
-
-
Exit the Insight Tile Definition program.
-
Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).
-
Create a new custom tile (or select an existing business insight tile) to launch the Tile Builder program:
-
Select the Edit Tile Summary function to launch the Tile Builder - SQL Definition program:
You can also manually edit the SQL statement by selecting the Edit Tile Detail button.
-
Indicate the anchor data source at the Primary data source field.
You can use the Select data source function to search for and select the data source using the Data Sources program.
-
Once the main data source has been defined, select the Select column function at the Value field.
-
The Data Sources program is launched, from where you can select the relevant column from the Columnslist view.
Once you have selected the column, the column name is displayed next to the Value field in the Tile Builder - SQL Definition program.
-
Select the Validate SQL and Close function to exit the Tile Builder - SQL Definition program.
-
-
Select the Save and Close function to exit the Tile Builder program.
-
-
Exit the Insight Tile Definition program.
Certain business insight tiles (e.g. Number of users logged into SYSPRO or Total Accounts Receivable balance for the company) only display holistic information and therefore don't require any context (i.e. defined parameters or keys).
While other tile types are context driven and therefore require additional information (such as keys or parameters) to display the appropriate values.
For example:
-
Customer outstanding balance
When a business insight tile is added to the Customer Query program to display the current customer balance, the customer key (from the ArCustomer table) is required so that the relevant condition can be included in the SQL statement.
The SYSPRO user interface gathers a list of the key fields provided in the various forms and toolbars. Therefore, when a user selects a tile, the list of keys (together with their current values) are then passed to the tile.
You can access the key value and use it within your SQL query by defining an appropriate key type field against the tile.
For example:
For the Customer balance for a customer business insight tile, you could do the following:
-
Define the Key type field as Customer.
This means, that if there is a customer key available at run time then the value can be used by the SQL query of the tile to select the current customer code.
Sample SQL Preamble:
declare @Customer varchar(${Customer.Length})
set @Customer = '$Customer'
The ${Customer.Length} variable will be replaced at run time with the length of the customer key in SYSPRO (currently 15 characters).
The $Customer variable that will be replaced at run time by the actual customer key.
SQL Condition:
Customer = @Customer
Sample SQL query script:
--SQL=Generated
--SQL=Preamble
declare @Customer varchar(${Customer.Length})
set @Customer = '${Customer}'
--SQL=Select
select
@Customer as 'SubTitle',
CurrentBalance1 as 'Value'
from
[ArCustomerBal] with nolock
where
Customer = @Customer
GO
If you select a key type and then edit the tile summary's SQL statement, an appropriate SQL preamble is provided. The SQL preamble shows how to take the key of the item at run time and create a SQL variable that can be used in the SQL select statement condition (WHERE statement).
Due to this automatic SQL preamble creation, we recommend that you select the key type before defining your tile summary or tile detail SQL statement.
Using
-
Press Ctrl+F1 within a list view or form to view a complete list of functions available.
Referencing
This lets you create a new business insight tile based on an existing tile.
You can't change the Tile type when using this option, as the tile type is inherited from the original business insight tile.
This lets you edit the SQL statement (i.e. data source, columns and conditions) of the business insight tile using the Tile Builder - SQL Definition program.
This lets you edit the detail of the business insight tile using the Tile Builder - SQL Definition program.
This refreshes the Standard Tile Preview and Large Tile Preview panes based on your criteria.
This lets you delete a custom business insight tile.
Field | Description |
---|---|
Tile header |
|
Tile ID |
This displays the unique 6-character alphanumeric identification code of the business insight tile. |
Tile type |
This indicates the type of tile:
|
Description |
This is the description of the business insight tile, which should contain enough information to ensure the tile's purpose is understood. |
Help text |
This lets you create a tool tip with help text for the business insight tile. The help text is then displayed when you drag the tile onto the screen or when the mouse pointer hovers over the tile. |
Key type |
This lets you select a unique identifier that will be used for the business insight tile and is typically the primary key of the source data or table. It is not essential for a business insight tile to have a key type as some tiles don't require any context and simply display the data without any defined parameters or keys. |
Category |
This lets you select a category in which the business insight tile will be grouped. This is mainly used to easily locate tiles within the list view. |
In development |
This lets you indicate that the business insight tile is currently still in development or testing. When this is enabled, the tile can be viewed, changed or deleted, but it can't be assigned to a workspace. |
Detail columns (0=Default) |
This lets you select the number of columns that are displayed when selecting the detail view at run time. You can specify a number between 0-10, where 0 means the default number of columns are displayed. |
Activity |
This lets you assign one or more business activities associated with the purpose of the tile. The business activities could be seen as departments within the organization that would find this business insight tile useful. This field is currently documentary but may be used in future for tile selection. |
Configure parameters |
Select the Assign parameters hyperlink to define one or more parameters of the tile using the Tile Builder - Parameters program. |
Summary Tile |
This section lets you specify the summary properties for the business insight tile. You can include a receiving variable ({SubTitle}, {Value} or {Footer}) which is then replaced at run time using the results of the tile summary SQL statement. |
Title |
Enter a mandatory title for the business insight tile. This defaults to the tile description. |
Subtitle |
Enter a subheading or string that is displayed below the heading. |
Value |
This is a mandatory field and defaults to {Value}, but may be a date as well. |
Footer |
Specify a footer for the tile, which is displayed below the value. |
Summary tile - Alternate |
If a value is entered for the key type when the tile is added to the user’s workspace, then the fields in the Summary tile - Alternate section are used to format the tile. If no value is entered for the key type, then it is assumed that key type value must be retrieved from the application in context, in which case the Summary tile fields will be used to format the tile. |
Subtitle 2 |
Enter an alternate subtitle. |
Value 2 |
Enter an alternate subtitle. |
Footer 2 |
Enter an alternate footer. |
Chart title |
These fields are only available if the Tile type is defined as Bar chart or Line chart. |
Chart title |
Enter a heading for the chart that must be displayed on the business insight tile. |
Number of series (1-4) |
Specify the number of series you require for the chart. For each series, you must return one row of data from your chart SQL statement. Each row represents one series, where the first row represents the first series, etc. |
Number of points (1-24) |
Specify the maximum number of data points that your chart SQL statement must return. Each data point is populated from a column named Px, where x represents a number (e.g. P1, P2, etc.). For example: If you have 6 data points then your SQL statement should return columns named P1, P2, P3, P4, P5 and P6. |
Chart details |
Select the Configure chart hyperlink to specify the following chart details:
|
Title preview simulated values |
The fields in this section are used to display the data in the Standard Tile Preview and Large Tile Preview. The strings entered in the Preview variable fields will simulate the receiving variable being returned from the SQL statement at run-time. This is used to simulate the look and feel of the business insight tile. Tile previews are not available for chart-type tiles. Therefore, only the chart title is displayed. |
Preview variable: {SubTitle} |
Enter an optional string to be used when displaying the sub title in the tile preview. |
Preview variable: {Value} |
Enter an optional string to be used when displaying the value in the tile preview. |
Preview variable: {Footer} |
Enter an optional string to be used when displaying the footer in the tile preview. |
Foreground color |
Select one of the pre-defined foreground colors for the tile preview. Alternatively, select Custom RGB to define the color at the Foreground colour RGB field. The color selected here is only for the simulated tile preview and won't be used when adding the tile to a workspace. |
Foreground color RGB |
This lets you use the color picker to choose a foreground color for the preview tiles. |
Background color |
Select one of the pre-defined background colors for the tile preview. Alternatively, select Custom RGB to define the color at the Background colour RGB field. The color selected here is only for the simulated tile preview and won't be used when adding the tile to a workspace. |
Background color RGB |
This lets you use the color picker to choose a background color for the preview tiles. |
This pane is displayed when you select the Create From function of this program, or the New Tile function of the Insight Tile Definition program.
This saves the details you entered or changed.
Field | Description |
---|---|
Tile ID |
This lets you specify a unique 6-character alphanumeric identification code for the tile. The default tile ID is USRxxx, where:
|
Tile type |
Select the type of tile you want to create:
The tile type can't be changed when you are copying a tile, as the new tile inherits the type from the copied tile. |
Description |
This lets you enter a description for the tile. The tile description is displayed in the Tiles list view of the Insight Tile Definition program and is editable after you create the tile. If you are copying a tile, (copy) is added to the original tile description, but this can be overridden if required. |
Change file name |
The file name of the tile is auto-generated using the description, but can be changed if required. Select this option to change the file name. |
Override file name |
This lets you enter a file name and is only available if you enable the Change file name option. |
Full file name |
This displays the full file name as it will be saved in the \Plugin\CustomStore folder. The file name includes the tile ID and description. |
This window is displayed when you create a chart tile and select the Configure chart hyperlink at the Chart details field.
This saves the changes made.
Field | Description |
---|---|
Series information |
This lets you define a name for each series you have specified at the Number of series field. |
X-Axis labels |
This lets you define each X-Axis label. Each label can contain an optional receiving variable by placing a value in brackets (e.g. {Lab1}). If you are returning multiple rows, then the receiving variables will typically be duplicated for each row (e.g. {Lab1}, {Lab2}, etc.). For consistency, we recommend that you use the same values when using receiving variables. To keep the tile visually simple and uncluttered, the X-Axis values are currently not displayed when tiles are shown at run time. However, a value must be defined for each X-Axis label otherwise the data points with blank values won't be displayed on the chart. |
X-Axis tooltips |
The X-Axis tooltips are displayed when the user moves the mouse over the data point on the business insight tile. Each tooltip can contain an optional receiving variable by placing a value in brackets (e.g. {Tip1}). If you are returning multiple rows, then the receiving variables will typically be duplicated for each row (e.g. {Tip1}, {Tip2}, etc.). For consistency, we recommend that you use the same values when using receiving variables. The X-Axis tooltips defined here are appended to the tooltip that is displayed when the mouse is moved over a chart data point. The tooltip displayed is a concatenation of the series name, data point value and the relevant X-Axis tooltip defined here. |
Copyright © 2022 SYSPRO PTY Ltd.