Tile Builder - Parameters
This program lets you define parameters for business insight tiles.
Exploring
This program can't be run standalone and is accessed from the following program(s):
-
Tile Builder
From the Assign parameters hyperlink of the Configure parameters field (within the Tile Properties pane).
The wording of the hyperlink changes once parameters have been assigned to the business insight tile, as the hyperlink then reflects the names of the assigned parameters.
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.
Starting
The following configuration options in SYSPRO may affect processing within this program or feature, including whether certain fields and options are accessible.
SYSPRO Ribbon bar > Setup > Operators
-
Tile KPI definition access control
-
You can assign a maximum of 10 parameters per tile.
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
-
Columns in a list view are sometimes hidden by default. You can reinstate them using the Field Chooser option from the context-sensitive menu (displayed by right-clicking a header column header in the list view). Select and drag the required column to a position in the list view header.
-
Fields on a pane are sometimes removed by default. You can reinstate them using the Field Selector option from the context-sensitive menu (displayed by right-clicking any field in the pane). Select and drag the required fields onto the pane.
The captions for fields are also sometimes hidden. You can select the Show Captions option from the context-sensitive menu to see a list of them. Click on the relevant caption to reinstate it to the form.
If the Show Captions option is grayed out, it means no captions are hidden for that form.
-
Press Ctrl+F1 within a list view or form to view a complete list of functions available.
Referencing
This saves the details you entered or changed.
This lets you change details for the currently highlighted record.
This list view displays all the parameters currently assigned to the tile.
This saves the details you entered or changed.
Field | Description |
---|---|
Name |
This indicates the parameter name, which can consist of the following characters (up to a maximum of 30 characters):
The parameter name can't contain any spaces. |
Description (prompt) |
This indicates the tile description that is used as the prompt when configuring a tile, and can consist of up to 100 characters. Most of the SYSPRO standard tiles use Enter xxxx. |
Type |
KeySingle
This defines the parameter as a single key that can be selected from a predefined list at the Key type field. List
This indicates that a comma separated list will be displayed when the tile is configured against a workspace. You can then define this list within the List field. The first entry is used as the default value. KeyList
This indicates that the user configuring the tile against the workspace can enter a comma separated list of keys (e.g. a list of customers or stock codes). The key must then be selected from a predefined list at the Key type field. |
Key type |
Indicate the key type that is used for the KeySingle and KeyList parameter types. This can be left blank if the required key is not listed in the predefined list of keys. |
List |
This lets you define the list that is used for the List parameter type. You can enter a comma separated list of items (up to a maximum of 100 characters) that will be displayed to the user configuring the tile. The first entry is used as the default value and no validation is performed on the values. |
Copyright © 2022 SYSPRO PTY Ltd.