SYSPRO Embedded Analytics

The SYSPRO Embedded Analytics feature provides analytical dashboards and visualization capabilities that help you manage core aspects of the business’s operations, without needing third-party business intelligence solutions.

As well as supplying you with a business management system that acts as a system of insight, it also empowers SYSPRO users to easily create, customize and deploy dashboards and visualizations anywhere in SYSPRO.

SYSPRO Embedded Analytics lets you transform your current data into visualizations and dashboards, providing decision making analysis to business users and functional roles.

PDF version

Exploring

The SYSPRO Embedded Analytics module form part of SYSPRO's Enterprise Reporting capabilities and empowers you to create, manage and deploy both operational and analytical dashboards into SYSPRO. This is achieved using the SYSPRO Web View technologies and is based on SYSPRO's Business Activity Queries (for input data).

Therefore, SYSPRO Embedded Analytics provides the following functionality:

  • Engaging and intuitive dashboards:

    Understand complex data and work more efficiently directly within SYSPRO.

  • Real-time streaming and data playback with the innovative data DVR:

    Stream both real-time and historical data to dashboards to visually analyze changes in real-time and over time.

  • Custom Visualizations:

    Build an interactive experience with custom visualizations for more clarity and deeper insights into your data.

  • Fully Interactive Visualizations:

    • Drill down or across to reveal more answers from your data.

    • Explore trends over time and discover outliers and anomalies.

    • Get to the details quickly with just a few clicks to see raw data.

  • Improved operation visibility and analytical capabilities:

    SYSPRO Embedded Analytics provides you with the answers you need, within the application you’re using; thereby enabling faster awareness and improved decision making in response to operational changes.

  • Cost savings:

    Centralized and embedded data analytics without the requirement for investment in third party solutions.

  • Easy to use:

    Built-in dashboard design and embedding experience (with little to no requirement to learn coding or reliance on development skills) means you can design and maintain your own data connections, visualizations and analytical dashboards quickly and easily.

  • Reliable security:

    SYSPRO Embedded Analytics integrates with existing SYSPRO security to provide a frictionless authentication experience, while maintaining granular control with row, column and object level security.

  • Reduced risk:

    Associated with disparate reporting and analytical solutions and improved resilience through centralization of reporting.

SYSPRO Embedded Analytics comprises of the following components:

This diagram depicts the components and services used within SYSPRO Embedded Analytics:

  • When a SYSPRO operator accesses the SYSPRO Embedded Analytics module, they are directed to the SYSPRO Application Gateway service. This includes activities such as:

    • Viewing dashboards

    • Designing dashboards

    • Configuring SYSPRO Embedded Analytics

    • Generating user access tokens to authenticate users

    • Querying existing dashboards when designing user interfaces

  • The SYSPRO Application Gateway performs two functions:

    • It converts any HTTPS traffic to HTTP and then directs the user through to Embedded Analytics.

      Note that an SSL certificate is required if converting from HTTPS.

    • It abstracts away the actual endpoint for SYSPRO Embedded Analytics to ensure security (i.e. the endpoint is not visible outside of the organization).

The programs related to this feature are accessed from the SYSPRO Ribbon bar:

  • Program List > Embedded Analytics

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.

An SYSPRO Embedded Analytics connection refers to the active connection with a smart connector that allows access to your data store.

A Source configuration within SYSPRO Embedded Analytics is a bucketed collection of rows and columns pulled from a connected datastore (i.e. database). These collections and their cached aggregated results are used to drive the visual creation process, while simultaneously helping to build data-driven insights (i.e. dashboards).

A SYSPRO Embedded Analytics visualization (or visual or widget) is a single, reusable visual that’s driven by one of your defined sources. It's purpose is to be used as a component within Embedded Analytics dashboards.

Services

SYSPRO Application Gateway

Starting

To use this feature, the following technology prerequisites are required:

  • SYSPRO Application Gateway service

  • PostgreSQL 12 (Configured server-side)

  • Microsoft Edge WebView2

    This controller must installed on the SYSPRO Desktop Client for SYSPRO users to be able to design and deploy dashboards.

    This is built into the Client install from SYSPRO 8 2022 onwards.

Recommendations:

We recommend using Windows Server 2019 or higher, with at least 16GB RAM and 4 cores.

To use this feature, the following module(s) must be installed according to the terms of your software license agreement:

  • SYSPRO Embedded Analytics

    In addition, you must have licensed Embedded Analytics designer seats configured within your SYSPRO license.

Additionally, to gain the most benefit from this feature, you should ideally be utilizing the following modules:

  • System Administration

  • Sales Orders

  • Purchase Orders

  • Inventory Control

  • Work in Progress

  • General Ledger

Setup Options > System Setup > Connectivity

To use this feature, the following setup options must be configured:

  • Application Gateway service settings

    This lets you connect to the SYSPRO Application Gateway service.

  • Embedded Analytics > Endpoint

    This lets you connect to SYSPRO Embedded Analytics.

  • Configure

    This configures your SYSPRO Embedded Analytics environment.

SYSPRO Ribbon bar > Setup > Operators

  1. Download PostgreSQL 12.

    You can download the latest version of the PostgreSQL 12 software (e.g. PostgreSQL 12.13) from the following URL: https://www.enterprisedb.com/downloads/postgres-postgresql-downloads.

  2. Install PostgreSQL 12.

Ensure that you take note of the following PostgreSQL entries, as they are required later during the Embedded Analytics install:

  • Password

  • Port

  1. Launch the SYSPRO Installer Application.

  2. Once a connection is made to the SYSPRO Deployment Service, login using your InfoZone credentials.

    If you are a partner or super-user, enter the applicable Customer ID for the customer being installed.

  3. From the SYSPRO Installer Application home screen, select the SYSPRO ERP Software option.

  4. From the Deployment Groups screen, select the relevant Deployment Group.

  5. From the Release Selection screen, select the SYSPRO 8 2022 (or later) release.

  6. From the Product Selection screen, select the SYSPRO Application Gateway service.

    The SYSPRO Installer verifies your system against all prerequisites required for the products you select to install. Should any product fail a prerequisite check at this stage, the Prerequisites screen is displayed.

  7. From the Review Product Parameters screen, review all parameters required for the service:

    Parameter Description and considerations

    HTTP Port

    Indicate if you want to use an HTTP port.

    Default port number provided: 30800

    Accept the default provided or change manually to match your preference.

    Add HTTP port to firewall

    For best practice, enable this option to ensure that the port number is added to your firewall.

    HTTPS Port

    Indicate if you want to use an HTTPS port.

    Default port number provided: 30801

    Accept the default provided or change manually to match your preference.

    SSL certificate details are required when selecting this port type.

    Add HTTPS port to firewall

    For best practice, enable this option to ensure that the port number is added to your firewall.

    Certificate Store

    This indicates the SSL certificate store found against your system.

    This field is read only and can't be changed.

    Certificate Subject

    Select the Browse icon to retrieve the relevant SSL certificate to use for running your web client.

    This launches the Parameter Certificate Browser screen with the valid and current SSL certificates available under the default stores.

    The selection defaults to the first item found in the Store list which subsequently loads the Subjects (also defaulting to the first item in the list).

    From here you can browse for and select the applicable SSL certificate.

    Certificate Subject Overwrite

    This indicates the current SSL certificate subject, if the Overwrite Subject option was enabled within the Parameter Certificate Browser screen.

    This field is read only and can't be changed.

    Please enter the SYSPRO Gateway Read Only Authentication key

    Enter a read-only authentication key for the SYSPRO Application Gateway service.

    You can define any password, pass-phrase or secret for this authentication key, and once defined its stored in the Gateway’s configuration as a hashed value.

    Ensure that you take note of this key as it may be required later when configuring the gateway.

    Please enter the SYSPRO Gateway Authentication key

    Enter a value for the SYSPRO Application Gateway authentication key.

    You can define any password, pass-phrase or secret for this authentication key, and once defined its stored in the Gateway’s configuration as a hashed value.

    If you plan on installing the SYSPRO Embedded Analytics module:

    Ensure that you take note of this key as it will be required during the install for SYSPRO Embedded Analytics, as well as within the Setup Options program when configuring your environment.

    Destination Folder

    Default provided: C:\Program Files\SYSPRO\SYSPRO Application Gateway

    Accept the default provided or change manually to match your preference.

  8. From the SYSPRO License Agreement screen, read and accept the license terms and conditions before continuing with the install.

  9. A summary of all products to be installed is displayed for you to review.

    Once you are satisfied with the list, continue by selecting the Begin Install button.

  10. The Install Complete screen is displayed with a summary of all products installed.

  1. Launch SYSPRO 8 2022 (or a later version).

  2. Open the Setup Options program (SYSPRO Ribbon bar > Setup).

  3. Navigate to the Connectivity System Setup form (Setup Options > System Setup > Connectivity).

  4. Enable the Use Application Gateway service option.

  5. Enter the service endpoint for the Application Gateway service endpoint.

    For example:

    http://Localhost:30800

  6. At the Authentication key field, enter the SYSPRO Gateway Authentication key which you used when installing the SYSPRO Application Gateway service.

  7. Select the Test connection function to confirm all details captured are correct and that you can connect to the service successfully.

  8. Save your changes and exit the program.

  9. Exit SYSPRO.

  1. Launch the SYSPRO Installer Application.

  2. Once a connection is made to the SYSPRO Deployment Service, login using your InfoZone credentials.

    If you are a partner or super-user, enter the applicable Customer ID for the customer being installed.

  3. From the SYSPRO Installer home screen, select the SYSPRO Additional Software option.

  4. From the Additional Software Packages screen, select the SYSPRO Embedded Analytics option.

  5. The SYSPRO Embedded Analytics screen is displayed, indicating the files to be installed.

    The SYSPRO Installer verifies your system against all prerequisites required for the products you select to install. Should any product fail a prerequisite check at this stage, the Prerequisites screen is displayed.

  6. From the Review Product Parameters screen, review all parameters required for the product:

    Parameter Description and considerations

    PostgreSQL Hostname

    This indicates the name of the machine on which the PostgreSQL service is hosted.

    PostgreSQL Port

    This indicates the port on which the PostgreSQL service is running.

    Default port number provided: 5432

    Accept the default provided or change manually to match your preference.

    PostgreSQL Password

    Enter the password for the database super user (postgres) which you defined when installing PostgreSQL.

    This enables access to the PostgreSQL database.

    SYSPRO Embedded Analytics Hosting Port

    Indicate the port on which the SYSPRO Embedded Analytics endpoint will be hosted.

    Default port number provided: 8090

    Accept the default provided or change manually to match your preference.

    If the SYSPRO Application Gateway and SYSPRO Embedded Analytics are installed on different machines, ensure that you add port 8090 to your firewall to ensure successful communication between them.

    SYSPRO Application Gateway Endpoint

    This indicates the hosting endpoint for the SYSPRO Application Gateway service.

    SYSPRO Application Gateway Authentication Key

    Enter the authentication key for the SYSPRO Application Gateway, as defined during the install of the SYSPRO Application Gateway service.

  7. From the SYSPRO License Agreement screen, read and accept the license terms and conditions before continuing with the install.

  8. A summary of all products to be installed is displayed for you to review.

    Once you are satisfied with the list, continue by selecting the Begin Install button.

  9. The Install Complete screen is displayed with a summary of all products installed.

  1. Launch SYSPRO 8 2022 (or a later version).

  2. Open the Setup Options program (SYSPRO Ribbon bar > Setup).

  3. Navigate to the Connectivity System Setup form (Setup Options > System Setup > Connectivity).

  4. At the Endpoint field within the Embedded Analytics section, you should see that entry has already been configured based on your install.

    For example: http://Localhost:30800/composer

  5. Select the Test connection function to confirm that you can connect to Embedded Analytics successfully.

  6. Select the Configure function to setup the Embedded Analytics environment for use within SYSPRO.

    The system then performs various functions in the background, including:

    • Configure the SYSPRO Embedded Analytics user interface.

    • Change default passwords against the default admin and supervisor users that are shipped with the product.

    • Import and apply OEM licensing and SYSPRO branding.

    • Setup SYSPRO Embedded Analytics instance and accounts

    • Create trusted access client for authentication.

    • Configure initial Data Source.

    • Add security groups for dashboards consumers and creators.

      Users that only view data are added to the dashboard consumer group and users that create dashboards are added to the dashboard creator group.

    • Create SQL login with read access to all of your SYSPRO companies and system wide dataset.

    • Create default connections in the Embedded Analytics environment.

      These are used for the sample dashboard packs shipped with the product and can be used by you to create dashboards that will show data for any SYSPRO company.

  7. Save your changes and exit the program.

  8. Restart SYSPRO for your changes to take affect.

To design Embedded Analytics dashboards, a SYSPRO operator must be configured with the correct access:

  1. Launch SYSPRO 8 2022 (or a later version).

  2. Open the Operator Maintenance program (SYSPRO Ribbon bar > Setup > Operators).

  3. Select the operator for whom you want to assign designer access for SYSPRO Embedded Analytics.

  4. Navigate to the Options pane (in the SYSPRO Desktop UI) or the Functions pane (in the SYSPRO Web UI (Avanti)).

  5. Enable the Embedded analytics designer option.

  6. Save your changes and exit the program.

    The system then calls into the SYSPRO Embedded Analytics environment and creates a user linked to this operator with permissions to create dashboards.

  7. Restart SYSPRO for your changes to take affect.

For Embedded Analytics Designers to be able to access the Embedded Analytics Designer program, access must be granted to either their group or role:

Solving

This message is displayed within the Operator Maintenance program if you attempt to define a SYSPRO operator as an Embedded analytics designer without first running the Embedded Analytics configuration in the Setup Options program.

Once you have installed the SYSPRO Embedded Analytics module, ensure to complete the setup and configuration within the Setup Options program (Setup Options > System Setup > Connectivity).

Then, when you select the Configure function within the Embedded Analytics section, your SYSPRO Embedded Analytics environment is configured.

The SYSPRO Desktop client web browser capabilities have been enhanced to utilize the latest Microsoft Edge WebView2 control technologies, allowing for rich and secure web browser experiences within SYSPRO.

This provides a more responsive browser experience and improves the compatibility between third-party web-based solutions and SYSPRO.

This message is displayed if the Microsoft Edge WebView2 control is not installed on your machine when you access the Embedded Analytics Designer program (i.e. one of the features that use Microsoft Edge exclusively from SYSPRO 8 2022).

Ensure to install the Microsoft Edge WebView2 controller on all client machines that require access to the Embedded Analytics Designer program.

You can download the runtime from the following link:

https://developer.microsoft.com/en-us/microsoft-edge/webview2/

When downloading the runtime, select either the Evergreen Bootstrapper download button, or the X64 button beneath the Evergreen Standalone Installer option.

Do not install the Fixed Version.

Once you have installed PostgreSQL 12 and the SYSPRO Application Gateway service, the following indicates the processes which occur when you select to install SYSPRO Embedded Analytics using the SYSPRO Installer Application:

  • The app collects all the required information for the install, ports, passwords, etc.

  • The connection to PostgreSQL is validated.

  • The required files are deployed.

  • The applicable services are created.

  • Property entries are updated.

  • The app calls the SYSPRO Application Gateway and creates the applicable entry.

  • The database and database user are created:

    The SYSPRO Embedded Analytics.msi retrieves the properties passed to it to enable access to PostgreSQL and create the required databases, as well as a user called zoomdata.

  • The services are started in the following order:

    1. PostgreSQL (unless already running)

    2. SYSPRO Application Gateway (unless already running)

    3. zoomdata_consul

    4. zoomdata_edc_* (i.e. data sources or connectors)

    5. zoomdata_query_engine

    6. zoomdata_data_writer_postgresql

    7. zoomdata_screenshot_service

    8. Zoomdata_service

  • Registry entries are written.

  • The SYSPRO Deployment Database is updated.

The SYSPRO Install stores its registry keys under the following path:

HKEY_LOCAL_MACHINE\SOFTWARE\SYSPRO\Installs\SYSPRO Embedded Analytics

Do not edit the zoomdata.properties file manually (i.e. outside the install) as any changes you make will be lost when you perform a repair of the install.

The following ports are used:

Port number

Service name

Comments

5432

zoomdata-postgres

Composer metadata repository

5580

zoomdata-query-engine

Composer query engine microservice

8090

zoomdata

Composer server

8081

zoomdata-data-writer

Composer Data Writer microservice

8083

zoomdata-screenshot-service

Composer Screenshot microservice

8100

zoomdata-edc-mssql

Microsoft SQL Server connector

8105

zoomdata-edc-postgresql

PostgreSQL connector, Flat File uploads, and Upload API processing

8300

zoomdata-consul

Internal port used by the Consul for inter-node communication in a distributed environment

8301

zoomdata-consul

Internal port used by the Consul for inter-node communication in a distributed environment

8302

zoomdata-consul

Internal port used by the Consul for inter-node communication in a distributed environment

8443

zoomdata

Composer HTTPS requests

8500

zoomdata-consul

Consul

The SYSPRO Application Gateway ensures that any request within SYSPRO to display SYSPRO Embedded Analytics dashboards is communicated through this service.

In addition, this service enables the SYSPRO Web UI (Avanti) to be run in HTTPS when accessing SYSPRO Embedded Analytics dashboards. The reason for this is that, as you can't mix HTTP and HTTPS content in a web client, any analytical data requested needs to be provided over an HTTPS connection for security purposes.

As the SYSPRO Embedded Analytics module doesn't form part of the standard SYSPRO release cycle, the update process for this module is slightly different to other SYSPRO products.

Therefore, when an update is made available, proceed as follows:

  1. Launch the SYSPRO Installer Application.

  2. Once a connection is made to the SYSPRO Deployment Service, login using your InfoZone credentials.

    If you are a partner or super-user, enter the applicable Customer ID for the customer being installed.

  3. From the SYSPRO Installer home screen, select the SYSPRO Additional Software option.

  4. From the Additional Software Packages screen, select the SYSPRO Embedded Analytics option.

  5. If an update is available when the SYSPRO Embedded Analytics page loads, the existing local product files (including the related XML and install files) are deleted and the latest files are retrieved from Azure. This ensures that the latest files are always used.

    The SYSPRO Embedded Analytics item is then marked as [UPDATE Available].

    Select the Continue button to proceed with the update.

  6. From the SYSPRO License Agreement screen, read and accept the license terms and conditions before continuing with the update.

  7. A summary of all products to be updated is displayed for you to review.

    Once you are satisfied with the list, continue by selecting the Begin Install button.

  8. The Install Complete screen is displayed with a summary of all products installed.

You can uninstall the SYSPRO Embedded Analytics service via the Windows Programs and Features application.

Take note though that you can't remove the existing configuration of your SYSPRO Embedded Analytics environment as configuration data is stored both in the SYSPRO SQL and PostGres databases which can't be deleted once configured.

However, a new function is being built into the Setup Options program that will enable you to disable the use of SYSPRO Embedded Analytics if required.

This option is due to be released during the life of SYSPRO 8 2022.

Stopping the zoomdata_consul service should stop all other services as they are dependent on the zoomdata_consul service.

After a new install or upgrade, you might not be able to access SYSPRO Embedded Analytics until the zoomdata service has completed its checks and database updates (which can take up to 15 minutes).

To verify if this is the cause for your services not starting, open the Task Manager and look for a high running java process that belongs to zoomdata. If present, wait for the process to calm down, after which you should be able to continue.

If however, this does not resolve the problem, check to see if the port is already in use by another application.

See the What ports does SYSPRO Embedded Analytics use FAQ for information regarding port numbers.

If the above doesn't resolve the issue either, proceed as follows:

  1. Check the log files for any error recorded.

  2. Stop all of the zoomdata services.

  3. Delete the log files.

  4. Restart the zoomdata services in correct sequence:

    1. zoomdata_consul

    2. zoomdata_edc_* (i.e. data sources or connectors)

    3. zoomdata_query_engine

    4. zoomdata_data_writer_postgresql

    5. zoomdata_screenshot_service

    6. Zoomdata_service

There are a few possible reasons for your not being able to connect to SYSPRO Embedded Analytics. Therefore, check each of the following:

  1. SYSPRO Application Gateway service:

    1. Check the configuration file of the SYSPRO Application Gateway for an Embedded Analytics entry.

  2. PostgreSQL:

    1. Check if anything has been changed in your PostgreSQL configuration.

    2. Confirm that you have the correct version of PostgreSQL: PostgreSQL 12.

  3. SYSPRO Configuration:

    1. Validate your connection to the SYSPRO Embedded Analytics endpoint by using the Test Connection function against the Embedded Analytics setup option (Setup Options > System Setup > Connectivity).

The following considerations are being addressed and should be resolved with a later release of the software:

  • KPI or Metric visualizations don't have a drill-down capability.

  • When using the Embedded Analytics Designer program in the SYSPRO Web UI (Avanti) version:

    • After creating a new dashboard, you must log out and back in for the new dashboard to reflect within the list of Embedded Analytics cards.

    • When you change your settings to use the Dark theme, you must refresh the page for the change to reflect.

Using

The Embedded Analytics Designer program is where you can configure your data connections and sources for SYSPRO Embedded Analytics, as well as design and view browser-based business intelligence dashboards:

The Connections panel lets you manage all active connections to the available smart connectors. Its where you connect to your data store by inputting your database credentials and connection string.

Considerations:

  • You can setup many connections to different databases, which will then apply within the Sources panel.

  • Available connections are defined by the embedded analytics designer.

SYSPRO Embedded Analytics uses a classification system to interpret and bucket your data into three primary types:

  • Attributes

  • Metrics

  • Time

Primary Data Type: Attributes

Attributes represent a set of discrete labels (i.e. categories) that are often grouped together in charts.

Considerations:

  • Data that is categorical in nature.

  • Used in visuals as the “group by” object.

    For example:

    Airport, Airlines, User ID, State, City, product name

Related Data Type: Text

This is a related data type for attributes which has a relationship that’s defined based on being an object that can be categorized. Text is primarily used in conjunction with smart connectors that have a text search capability.

Considerations:

  • Data that is categorical in nature, just like attributes.

  • Primarily used with search-based connectors.

    For example:

    Apache Solr, Cloudera search and Elasticsearch use cases

Primary Data Type: Metrics

This is a numerical unit used for calculations and aggregations. Common metrics may be the order count, revenue generated, etc.

These are broken down into two sub classifications:

  • Numbers (i.e. floating values)

  • Integers (i.e. whole numbers)

Considerations:

  • Used in calculations and aggregation

  • Often used as a baseline count

Primary Data Type: Time

This is a special typing in SYSPRO Embedded Analytics as time is treated as the primary driver for smart data insights and provides the ability to view historical datasets over configured points in time.

Considerations:

  • You can explore historical data with the Timebar.

  • Some data sources allow for data playback and live streaming.

The Source panel enables you to manage all active source definitions currently available within the selected account, as well as leverage a connected data store to build a new source configuration.

Once you connect to a database, you can generate a source configuration (i.e. pull data and prepare it to be used in conjunction with a visual or dashboard) by using one of the following:

  • Business Activity Queries

  • Table and database schema

  • Materialized view

  • Custom SQL statement (i.e. for more detailed definition)

The selected data is then prepped for end user consumption by applying friendly names, filter defaults, distinct count, etc.

The source configuration is then saved for future visual creation.

The Visual Gallery panel is where you can build a single, reusable visual that’s driven by one of your defined sources.

The visualization types available include:

  • Arc gauge

  • Bar charts:

    • Bars

    • Histogram

    • Multiple metrics

  • Box plot

  • Bullet Guage

  • Combo chart

  • Donut

  • Floating bubbles

  • Heat map

  • KPI

  • List filter

  • Packed bubbles

  • Pie chart

  • Pivot table

  • Table

  • Scatter Plot

  • Tree map

  • Word cloud

The design capabilities within the visualization designer enable you to tweak and customize your visual, which you can then place into a dashboard later on.

The Library panel is where all your existing dashboards live.

The dashboards within your library, as well as your visualizations, can be embedded within SYSPRO in various ways:

  • SYSPRO Web UI (Avanti):

    • Role-based SYSPRO Workspaces

    • SYSPRO program web views

  • SYSPRO Desktop:

    • SYSPRO Main Menu

    • SYSPRO program web views

    • Application Builder

    • Application Designer

Embedded Analytics Designers are responsible for the dashboard management process, including:

  • Viewing dashboard information (i.e. dashboard name, the data source behind it, the content author and the last modified date)

  • Managing existing dashboards

  • Placing existing visuals (that were created in the gallery) into a dashboard

  • Creating new visuals within the dashboard canvas

  • Managing dashboard permissions (i.e. providing dashboard access to users and groups)

  • Marking specific dashboards as a favorite

Dashboard capabilities include the following:

  • Inline visually connected filters (i.e. any selection in one filter affects the others)

  • Dashboards as a whole can be governed by a time bar or time series (which when changed, affects all linked visuals)

  • Map type visuals can be zoomed into, enabling you to map countries, states and geolocations, etc.

  • Radial menus allows drill down, trending, zooming into data, etc.

  • End users can change the axis and dimensions being used on any of the visuals on-the-fly. The dashboard reverts to its original dimensions when the user exits and reloads the dashboard or workspace.

  • Zooming into data opens a list view (or data table) which represents the data behind the dashboard visual.

    This data can then also be exported to an Excel worksheet if required.

The following explains how to achieve each step of this process in detail:

The first step to creating dashboards, is to ensure you have a valid connection defined:

  1. Open the Embedded Analytics Designer program (Program List > Embedded Analytics).

  2. Navigate to the Connections panel.

  3. Select an existing connection by using one of the standard connections shipped by SYSPRO:

    • SYSPRO Dynamic Connection

    • SYSPRO Templates

    Alternatively, you can add a new connection by selecting the ADD Connection function:

    1. From the Connection Type window, select your required type of connection:

      • MS SQL

      • PostgreSQL

      The list of available connectors will be expanded in future releases.

    2. From the Input Credentials screen, input the following:

      • Connection Name

      • Jdbc Url

      • User Name

      • Password

    3. Select the Validate function to save your newly created connection.

    Your new connection is then included in the list of available connections.

The next step is to generate a source configuration by pulling your data and preparing it for use within a visual or dashboard:

  1. Open the Embedded Analytics Designer program (Program List > Embedded Analytics).

  2. Navigate to the Sources panel.

  3. Select either an existing source configuration, or the Add Source function to create a new source configuration.

    Proceed as follows when creating a new source:

    Within the Source Definition section:

    1. Indicate a unique name for the source configuration.

    2. Optionally define a description for the source, so that other users can easily understand its use case.

    Within the Data Entity Definition section:

    1. Select the Add function to define your data entity (either from one of your connections or from a file).

      For the remainder of this task, we are using the SYSPRO Dynamic Connection as an example.

    2. Within the Data Entity Details section, enter an applicable Data Entity Name.

    3. At the Select Connection field, indicate which connection you want to use for the source.

      If you selected to add a source based on a file (and not a connection) use the Upload New File option to select the file you want to use.

    4. At the Select Entity field, indicate which tables you want to use from your data connection (or file).

    5. From Available Fields, indicate which columns you want to bring through for use within the visualization.

    6. Select the Apply function to save your data entity.

    7. Select the Save Source function to save your newly created source configuration.

  4. Navigate back to the Sources panel.

    Your newly created source configuration is included in the list of available sources.

Once your connection and source configuration have been defined, you can start creating the required visuals that you want to use within a dashboard:

  1. Open the Embedded Analytics Designer program (Program List > Embedded Analytics).

  2. Navigate to the Visual Gallery panel.

  3. Select the Add Visual function:

    1. From the Select a Source screen, indicate the source on which you want to base the visual by selecting it.

    2. From the Select Visual Type screen, indicate the visual type that you want to use.

    Your new visual is then displayed.

  4. Select the Info icon ():

    1. At the Visual Name field, enter an applicable title for the visual.

    2. Select the Save function.

      You will notice that the name of your visual now renders at the top of the screen.

  5. The remaining customization is not mandatory but enables you to customize the visual even further:

    • Visual Style ()

      Change the visual style.

    • Sort & Limit ()

      Define how the data is sorted, aggregated, ordered and limited.

    • Filters ()

      Add filters to the visual.

    • Time Bar ()

      Define a time series for the visual.

    • Settings ()

      Indicate the visual's orientation, labels and style.

    • Rulers ()

      Customize how the X and Y gridlines appear.

    • Color ()

      Change the visual's color palette.

    • Interactivity ()

      Define the level of user interaction allowed.

  6. Once you have completed your customization, select the Save function from the toolbar.

  7. From the Save Options window, confirm your acceptance of the visual's title and name.

  8. Navigate back to the Visual Gallery panel.

    Your newly created visualization is included in the list of available visuals.

You can now create your dashboard using the connection, source and visuals configured in the previous steps:

  1. Open the Embedded Analytics Designer program (Program List > Embedded Analytics).

  2. Navigate to the Library panel.

  3. Select the Add Dashboard function.

    You are presented with two options:

    • Add Visual

      This lets you create a new visual on-the-fly for use within the dashboard.

    • Place Existing Visual

      This lets you pull in an existing visual from your Visual Gallery.

    For the remainder of this task, we are using the Place Existing Visual as an example.

  4. From the Select a Visual window, indicate which visual you want to pull onto the dashboard.

    Once selected, the visual is immediately added to the dashboard canvas.

  5. Add as many visuals as you require.

    • You can also re-size the visuals and move them around on your dashboard canvas.

    • Use the context menu that appears on each visual (when you select the ellipses from the visual's top right-hand corner) to customize the dashboard visuals further.

  6. Once you are happy with the contents and layout of your dashboard, select the Save icon.

  7. Navigate back to the Library panel.

    Your newly created dashboard is included in the list of available dashboards.

    Selecting the dashboard again lets you preview or edit it.

    Previewing a dashboard is useful for dashboard authors to test what the end user experience will be like once the dashboard is embedded in SYSPRO.

The final step is to embed your newly created dashboard in SYSPRO for a user within a role:

SYSPRO Web UI (Avanti)

Process to follow when embedding within a Workspace in the SYSPRO Web UI (Avanti):

  1. Log into SYSPRO 8 2022 (or later) using the web UI.

  2. Select the Customize icon , followed by the Design Web Views by Role option.

  3. Select the role against which you want the dashboard to apply.

  4. Once in design mode, select the Customize icon , followed by Design Workspace for Role: xxx.

    Select the New Workspace option.

  5. Indicate an applicable name for the new workspace.

    The Visual Designer program is launched:

    1. Select the Add layout section option.

    2. Select the Embedded Analytics card.

    3. From the Select Dashboard section, select Other and then indicate the applicable dashboard you want to embed.

    4. Select the Add Section function.

      You can add as many layout sections as required and embed multiple visualizations or dashboards.

    5. Save the layout.

    6. Exit design mode by selecting the Customize icon , followed by Stop Designing by Role.

When a user within that role next logs into the Web UI, the newly created workspace will be available for them to access.

SYSPRO Desktop

Process to follow when embedding within a program in the SYSPRO Desktop UI:

  1. Log into SYSPRO 8 2022 (or later) using the desktop client.

  2. Open the program in which you want to embed a dashboard.

    If you want to design applications at Role level, then you must be in Design Mode before accessing the required program.

  3. Select the Customize icon , followed by the Design Web View option.

    A Primary layout is used in this example.

    This launches the Visual Designer and displays the current layout if one exists for the program.

    1. Select the Add layout section option.

    2. Select the Embedded Analytics card.

    3. From the Select Dashboard section, select Other and then indicate the applicable dashboard you want to embed.

    4. Select the Add Section function.

      You can add as many layout sections as required and embed multiple visualizations or dashboards.

    5. Save the layout.

  4. Exit the program.

    The updated web view will then be available when a user next logs into that program.

The following indicates areas in the product that may be affected by implementing this feature:

SYSPRO Ribbon bar > Setup

The following options enable you to configure your SYSPRO Embedded Analytics environment:

Embedded Analytics (Setup Options > System Setup > Connectivity)

  • Endpoint

  • Configure

SYSPRO Ribbon bar > Setup > Operators

The following option enables you to define a SYSPRO operator with access rights to the Embedded Analytics Designer program, from where they can design dashboards.

  • Embedded analytics designer

The Embedded Analytics card lets you embed an Embedded Analytics dashboard within any of the following:

  • SYSPRO Web UI (Avanti):

    • Role-based SYSPRO Workspaces

    • SYSPRO program web views

  • SYSPRO Desktop:

    • SYSPRO Main Menu

    • SYSPRO program web views

    • Application Builder

    • Application Designer

Program List > Embedded Analytics

This program lets you configure your data connections and sources for SYSPRO Embedded Analytics, as well as design and view browser-based business intelligence dashboards.