Tile KPI Maintenance

This program lets you define specific thresholds for targets or key performance indicators (KPIs) and highlight these values within business insight tiles.

Exploring

Things you can do in this program include:

  • Define thresholds for tiles
  • Define visual changes in tiles when threshold values are reached

This program can't be run standalone and is accessed from the following program(s):

  • Insight Tile Definition

    From the Add and Edit KPI hyperlinks in the Tiles list view.

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.

Topics

Business Insights

Starting

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

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.

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

Solving

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.

Once the business insight tile has been created, it can be assigned to a workspace using the Visual Designer 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 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.

Once the business insight tile has been created, it can be assigned to a workspace using the Visual Designer 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.

Once the business insight tile has been created, it can be assigned to a workspace using the Visual Designer 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.

Once the business insight tile has been created, it can be assigned to a workspace using the Visual Designer 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.

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.

Using

When adding KPI attributes to a tile using the Tile KPI Maintenance program, the tile value is compared to pre-defined thresholds.

When these thresholds are reached or exceeded, the visual appearance of the tile can change. This draws the user's attention, enabling them to take the appropriate action.

Therefore, the following tile attributes can be changed when a threshold is reached or exceeded:

  • Main value text color
  • Tile background color

  • Optional icon and icon color

When defining a KPI against a business insight tile, one of the following objectives must be specified for the threshold creation:

  • Minimizing

    • The ideal value must be as small as possible.
    • The value can be negative or zero.
    • The tile can have a warning high and a critical high threshold.
  • Maximizing
    • The ideal value must be as large as possible.
    • The tile can have a warning low and a critical low threshold.
  • Target value

    • The ideal tile value is fixed to a predefined value.

    • The value has high and low thresholds.

    • The warning and critical values lie within a range.

    • The tile can have a warning high and a critical high threshold, for both high and low values.
Warning and Critical Thresholds

You can define the warning and critical thresholds and indicate whether the value only has to be reached or exceeded.

  • When the warning threshold is reached or exceeded, a certain set of attributes is applied (e.g. an orange background).

  • When a critical threshold is reached or exceeded, another set of attributes is applied (e.g. a red background).

If no threshold is reached, the original tile attributes (defined at the time of creating the tile) are used.

KPIs against business insight tiles can be created for a number of different levels:

  • 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).

  • 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

Column Description

Description

This indicates the level at which the tile was created:

  • System-wide KPI indicates tiles created at system level
  • Company name indicates tiles created at company level
  • Role description indicates tiles created at role level
  • Operator name indicates tiles created at operator level

Item

Depending on which level the tile is created:

  • System is displayed for tiles created at system level
  • Company is displayed for tiles created at company level
  • Role is displayed for tiles created at role level
  • Operator is displayed for tiles created at operator level

Edit

Select the Add hyperlink to add the tile and define its KPI properties, or the Edit KPI hyperlink to edit the tile's existing KPI properties.

Delete

Select the Delete hyperlink within this column to delete the tile.

You can't delete standard system tiles that are shipped with the software.

This saves the new or edited KPI properties for the tile.

Field Description

Tile definition

 

Tile description

This indicates the description of the selected tile.

Tile goal

Indicate the tile's objective (i.e. what you want the tile to highlight):

Select this for tiles where the ideal value is as small as possible.

Select this for tiles where the ideal value is as large as possible.

Select this for tiles where the ideal tile value is fixed, but can deviate to either side.

Warning and critical values lie within a range.

Target value

Indicate the fixed value for tiles that are defined with Target value as their Tile goal.

Warning high

 

Warning high required

This lets you indicate that the tile must have a warning high value.

This applies to tiles with Minimizing and Target value goals, where the aim would be a value that is either fixed or as low as possible.

Threshold value

Enter the value on or above which the warning properties must be displayed.

Threshold condition

Indicate the warning threshold condition:

  • >= - greater than and equal to

    Warning properties are applied when the value is reached

  • > - greater than

    Warning properties are applied when the value is exceeded

Warning low

 

Warning low required

This lets you indicate that the tile must have a warning low value.

This applies to tiles with Maximizing and Target value goals, where the aim would be a value that is either fixed or as high as possible.

Threshold value

Enter the value on or below which the warning properties will be displayed.

Threshold condition

Indicate the warning threshold condition:

  • <= - less than and equal to

    Warning properties are applied when the value is reached

  • < - less than

    Warning properties are applied when the value is exceeded

Warning properties

 

Warning tile color

Specify the background tile color that will be applied when the warning threshold is reached or exceeded.

No background color will be applied.

The background color will change to orange.

The background color will change to red.

The background color will change to the default color (i.e. mid-tone blue).

The background color will change to turquoise.

The background color will change to green.

The background color will change to the inverse or opposite color.

The background color will change to gray.

The background color will change to light gray.

The background color will change to very light gray.

The background color will change to white.

The background color will change to a custom defined color (which you can select).

Warning tile color RGB

This displays the RGB color code for the selected color.

Warning value color

Specify the font color that will be applied to the value when the warning threshold is reached or exceeded.

The options here are the same as explained in the Warning tile color field.

Warning value color RGB

This displays the RGB color code for the selected font color.

Warning icon

Select the icon to be displayed in the left-hand bottom corner of the tile when the warning threshold is reached or exceeded.

Warning icon color

Specify a color for the icon that will be displayed when the warning threshold is reached or exceeded.

Warning icon color RGB

This displays the RGB color code for the selected icon color.

Critical high

 

Critical high required

This lets you specify a critical high value.

This applies to tiles with Minimizing and Target value goals, where the aim would be a value that is either fixed or as low as possible.

Threshold value

Enter the value on or above which the critical properties will be displayed.

Threshold condition

Select the critical threshold condition:

  • >= - greater than and equal to

    Warning properties will be applied when the value is reached

  • > - greater than

    Warning properties will be applied when the value is exceeded

Critical low

 

Critical low required

This lets you specify the critical low value.

This applies to tiles with Maximizing and Target value goals, where the aim would be a value that is either fixed or as high as possible.

Threshold value

Enter the value on or below which the critical properties will be displayed.

Threshold condition

Select the critical threshold condition:

  • <= - less than and equal to

    Warning properties will be applied when the value is reached

  • < - less than

    Warning properties will be applied when the value is exceeded

Critical properties

 

Critical tile color

Specify the background tile color that will be applied when the critical threshold is reached or exceeded.

The options here are the same as explained in the Warning tile color field.

Critical tile color RGB

This displays the RGB color code for the selected color.

Critical value color

Specify the font color that will be applied to the value when the critical threshold is reached or exceeded.

The options here are the same as explained in the Warning tile color field.

Critical value color RGB

This displays the RGB color code for the selected font color.

Critical icon

Select the icon to be displayed in the left-hand bottom corner of the tile when the critical threshold is reached or exceeded.

Critical icon color

Specify a color for the icon that will be displayed when the critical threshold is reached or exceeded.

Critical icon color RGB

This displays the RGB color code for the selected icon color.