Business Insights

You can either create a new text-type business insight tile from scratch, or copy an existing one and then change the tile details.

In this example, we are concentrating on creating a new text-type business insight tile:

1. Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).

2. To create a new tile definition, select the New Tile function.

   The Tile Builder program is displayed:

   1. From the New Tile window, configure the following tile details and select OK:

      • Tile type - select Text

        You can only select the tile type if you are creating a new tile, as it is inherited from the copied tile.

      • Tile description

      • File name

   2. From the Tile Properties pane, configure the following sections:

      • Tile header and parameters

        In the SYSPRO Web UI (Avanti) version, the Configure parameters link forms part of the Tile header section; whereas in the SYSPRO Desktop version, the parameters can be configured at the Parameters section.

      • Summary tile

      • Tile preview simulated values

        The variables will be replaced at runtime using the output of the tile summary SQL script.

        This functionality is only available in the SYSPRO Desktop version.

   3. Configure your SQL script:

      • Select the Edit Tile Summary function to configure the SQL script that is used to render the summary tile values – including the main tile value, together with optional subtitle and footer values.

      Or

      • Select the Edit Tile Detail function to configure the SQL script that is used to render the column values of the detail list view. These values are displayed when clicking on the tile to zoom into the details.

      You can use the Edit Tile Summary option to generate the SQL statement using a simple-to-use interface, or you can use the Edit Tile Detail option to define a custom SQL script which provides more flexibility when presenting sophisticated information.

      Select the Validate SQL and Close function to validate and save the SQL script, and return to the Tile Builder program.

   4. Preview the tile in the Tile Builder program.

   5. Select the Save and Close function to return to the Insight Tile Definition program.

3. Assign KPIs by selecting the Add hyperlink of the applicable column in the Tiles list view.

You can either create a new chart-type business insight tile from scratch, or copy an existing one and then change the tile details.

In this example, we are concentrating on creating a new chart-type business insight tile:

1. Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).

2. To create a new chart tile, select the New Tile function.

   The Tile Builder program is displayed:

   1. From the New Tile window, configure the following tile details and select OK:

      • Tile type - select Bar chart or Line chart

        You can only select the tile type if you are creating a new tile, as it is inherited from the copied tile.

      • Tile description

      • File name

   2. From the Tile Properties pane, configure the following sections:

      • Tile header and parameters

        In the SYSPRO Web UI (Avanti) version, the Configure parameters link forms part of the Tile header section; whereas in the SYSPRO Desktop version, the parameters can be configured at the Parameters section.

      • Chart tile

      • Tile preview simulated values

        The variables will be replaced at runtime using the output of the tile summary SQL script.

        This functionality is only available in the SYSPRO Desktop version.

   3. Select the Edit Tile Chart function to configure the SQL script that is used to render the summary tile values – including the main tile value, together with optional subtitle and footer values.

   4. Select the Validate SQL and Close function to validate and save the SQL script, and return to the Tile Builder program.

      You can then preview the tile.

   5. Select the Save and Close function to return to the Insight Tile Definition program.

3. Exit the Insight Tile Definition program.

You can either create a new text-type business insight tile from scratch, or copy an existing one and then change the tile details.

In this example, we are concentrating on copying an existing text-type business insight tile:

1. Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).

2. To copy an existing text tile:

   1. Select the applicable tile in the Tiles pane. This launches the Tile Builder program.

   2. Select the Create From function from the toolbar.

3. The New Tile window of the Tile Builder program is displayed:

   1. Configure the following tile details and select OK:

      • Tile description

      • File name

   2. Configure the following sections in the Tile Builder program:

      • Tile header and parameters

        In the SYSPRO Web UI (Avanti) version, the Configure parameters link forms part of the Tile header section; whereas in the SYSPRO Desktop version, the parameters can be configured at the Parameters section.

      • Summary tile

      • Tile preview simulated values

        The variables will be replaced at runtime using the output of the tile summary SQL script.

        This functionality is only available in the SYSPRO Desktop version.

   3. Select the Edit Tile Summary function to configure the SQL script that is used to render the summary tile values – including the main tile value, together with optional subtitle and footer values.

      Select the Edit Tile Detail function to configure the SQL script that is used to render the column values of the detail list view. These values are displayed when clicking on the tile to zoom into the details.

      You can use the Edit Tile Summary option to generate the SQL statement using a simple-to-use interface, or you can use the Edit Tile Detail option to define a custom SQL script which provides more flexibility when presenting sophisticated information.

   4. Select the Validate SQL and Close function to validate and save the SQL script, and return to the Tile Builder program.

      You can then preview the tile.

   5. Select the Save and Close function to return to the Insight Tile Definition program.

4. Exit the Insight Tile Definition program.

You can either create a new chart-type business insight tile from scratch, or copy an existing one and then change the tile details.

In this example, we are concentrating on copying an existing chart type business insight tile:

1. Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).

2. To copy an existing chart tile:

   1. Select the applicable tile in the Tiles pane. This launches the Tile Builder program.

   2. Select the Create From function from the toolbar.

3. The New Tile window of the Tile Builder program is displayed:

   1. Configure the following tile details and select OK:

      • Tile description

      • File name

   2. Configure the following sections:

      • Tile header and parameters

        In the SYSPRO Web UI (Avanti) version, the Configure parameters link forms part of the Tile header section; whereas in the SYSPRO Desktop version, the parameters can be configured at the Parameters section.

      • Chart tile

      • Tile preview simulated values

        The variables will be replaced at runtime using the output of the tile summary SQL script.

        This functionality is only available in the SYSPRO Desktop version.

   3. Select the Edit Tile Chart function to configure the SQL script that is used to render the summary tile values – including the main tile value, together with optional subtitle and footer values.

      You can use the Edit Tile Summary option to generate the SQL statement using a simple-to-use interface, or you can use the Edit Tile Detail option to define a custom SQL script which provides more flexibility when presenting sophisticated information.

   4. Select the Validate SQL and Close function to validate and save the SQL script, and return to the Tile Builder program.

      You can then preview the tile.

   5. Select the Save and Close function to return to the Insight Tile Definition program.

4. Exit the Insight Tile Definition program.

1. Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).

2. Select the New Tile function to create a custom tile.

   The Tile Builder program is launched:

   1. Enter the tile details within the New Tile window.

   2. 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:

      1. 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.

      2. 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.

      3. Select the Validate SQL and Close function to exit the Tile Builder - SQL Definition program.

   3. Select the Save and Close function to exit the Tile Builder program.

3. Exit the Insight Tile Definition program.

1. Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).

2. Create a new custom tile (or select an existing business insight tile) to launch the Tile Builder program:

   1. 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.

      1. 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.

      2. Once the main data source has been defined, select the Select column function at the Value field.

      3. 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.

      4. Select the Validate SQL and Close function to exit the Tile Builder - SQL Definition program.

   2. Select the Save and Close function to exit the Tile Builder program.

3. 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.

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.

declare @Customer varchar(${Customer.Length})
set @Customer = '$Customer'

Customer = @Customer

--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

You can export standard and custom business insight tiles as follows:

1. Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).

2. Select the Export function to launch the Tile Builder - Export program:

   1. Select the business insight tiles that you want to export by using the check box.

   2. Select the Export Selected Tiles function.

      The Export Tile Target window is displayed:

      1. In the SYSPRO Web UI (Avanti) version, specify the name of the target folder for the zip file. The target file name is Tile_Package.zip by default.

         In the SYSPRO Desktop version, specify the format and location of the tiles you want to export.

      2. Select the Export Tiles function.

         The Export Confirmation message that is displayed prompts you to confirm that you want to export the selected tiles.

3. Exit the Insight Tile Definition program.

Standard business insight tiles can't be imported, however you can import custom business insight tiles as follows:

1. Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).

2. Select the Import function to launch the Tile Builder - Import program:

   1. In the SYSPRO Web UI (Avanti) version, specify the source folder name where the zip file containing business insight tiles is located.

      In the SYSPRO Desktop version, specify the format and location of the tiles that you want to import.

   2. Select the Import Tiles button.

      The copied or extracted business insight tiles are then displayed within the Tiles list view.

   3. Select the business insight tiles you want to import and select the Import Selected Tiles function.

      The Import Confirmation message that is displayed prompts you to confirm that you want to import the selected tiles.

3. Exit the Insight Tile Definition program.

This depends on which SYSPRO User Interface is used:

• When using the SYSPRO Desktop version:

  When exporting single files, the default server target folder is ...\WORK\Tile_Import_Export (this folder is created if it doesn't exist at the time of the export).

  If you are exporting to a ZIP file, then the default server target file name is Tile_Package.ZIP.

  Alternatively, you can select different folders and file names if required.

  In a client-server environment, the files are exported to the temporary folder on the client computer by default, but this can be changed if required.

• When using the SYSPRO Web UI (Avanti) version:

  Only single files are exported to the Downloads folder specified in the browser settings.

  You can specify this folder when exporting the files if you enable the Ask where to save each file when downloading option in your browser's Downloads settings.

The following explains how to add key performance indicators to a business insight tile:

1. Open the Insight Tile Definition program (SYSPRO Programs > Administration > General Setup).

2. From the Tiles pane, highlight the tile for which you want to add KPIs.

3. Depending on the level at which the tile must be deployed, select the Add or Edit KPI hyperlink of the appropriate column:

   • System KPI

     This lets you add or maintain the tile at system-wide level (i.e. all operators will be able to see the tile).

   • Company KPI

     This lets you add or maintain the tile at company level (i.e. all operators that have access to the defined company will be able to see the tile).

   • Role KPI

     This lets you add or maintain the tile at role level (i.e. operators within the defined role(s) will be able to see the tile).

   • Operator KPI

     This lets you add or maintain the tile at operator level (i.e. only the operator for whom the tile is created will be able to see the tile).

   The Tile KPI Maintenance program is launched:

   1. From the Items pane, select the Add or Edit function of the Edit column.

      The KPI Properties pane is then available for editing.

   2. Edit the KPI properties as required.

   3. Select the Save or Save KPI function.

   4. Exit the Tile KPI Maintenance program.

4. Exit the Insight Tile Definition program.

You can't select a target value for Minimizing or Maximizing type tile goals. You can only use a fixed target value if the selected type goal is defined as Target Value.

If you change the icon on an existing tile, then the warning icon overrides the existing icon when the warning value has been reached or exceeded.

Similarly, the critical icon will override the warning icon if the critical threshold is reached or exceeded.

1. 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.

2. From the Visual Designer Program: IMPFRZ program, select the Add layout section function.

3. From the Configure new layout section window, select Tile Section.

4. Optionally enter a Section title at the Widget title placeholder and assign an icon to the tile if required.

5. Select the Add section function.

6. 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.

7. Drill down into the relevant category and select the tile you want to deploy.

8. (Optional) Define the following for the tile:

   • Width

   • Text

   • Tile background color

   • Icon

9. 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.

10. Select Save and Exit.

    Your tile will be displayed in the web view, immediately showing the appropriate insight information.

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.

SYSPRO Programs > Administration > General Setup

This program is the platform from where you can:

• View existing business insight tiles

• Create new tiles

• Assign KPIs

• Manage SQL scripts

• Import and export tiles

SYSPRO Programs > Administration > General Setup

This program lets you create and maintain chart and text type business insight tiles.

Accessible from the Assign parameters hyperlink at the Configure parameters field of the Tile Builder program (Tile Properties pane).

This program lets you define parameters for business insight tiles.

Accessible from the Edit Tile Summary or Edit Tile Detail function within the Tile Builder program.

This program lets you indicate the data source and data columns to be used for the SQL script of custom business insight tiles.

Accessible from the Import function within the Tile Builder program.

This program can be accessed from within the Insight Tile Definition program and is used to import business insight tiles.

Accessible from the Export function within the Tile Builder program.

This program can be accessed from within the Insight Tile Definition program and is used to export business insight tiles.

Program List > Administration > General Setup

This program lets you view changes made to business insight tiles, which are stored in the AdmTileAudit table.