SYSPRO Embedded Analytics

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 within the C:\ProgramData\SYSPRO\Application.Gateway\appsettings.reverseProxy.json file.

• 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 Services:

     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

• 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

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
30803	Zoomdata-consul	Server port
30804	Zoomdata-consul	Lan port
30805	Zoomdata-consul	Wan port

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 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 version then has an Upgrade button. Select the 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 Upgrade button.

8. The Upgrade 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, you can use the Embedded Analytics enabled setup option (Setup Options > System Setup > Connectivity) to activate or deactivate the usage of the SYSPRO Embedded Analytics feature, if required.

If you need to restart the zoomdata services for any reason, ensure to start them in the following order:

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

You can easily see all of the data connectors you have installed by viewing the Windows Services program.

The additional data connector services have a naming convention of Zoomdata EDC xxxx Connector (where xxxx indicates the provider).

This depends on if you already have SYSPRO Embedded Analytics installed or not:

• When installing SYSPRO Embedded Analytics for the first time:

  You can select the additional data connector(s) you require within the SYSPRO Installer Application, when configuring the parameters for the product install.

• If you already have SYSPRO Embedded Analytics installed, the process to install an additional data connector is handled via the Windows Control Panel:

  1. From the Programs and Features application, locate SYSPRO Embedded Analytics.

  2. Select the Change function.

     The SYSPRO Embedded Analytics Setup screen is displayed and provides a list of all data connectors available for installation.

  3. Select the drop down menu against the data connector(s) you want to install, followed by the Entire feature will be installed on local hard drive option.

  4. Follow the remaining steps required in the change wizard to complete the install of the selected data connector(s).

  For example:

  1. Location of product:

     

  2. Selection of Couchbase connector:

     

Data connector considerations

The following data connectors have their own custom files and require additional configuration if you want to enforce TLS Server Authentication (i.e. SSL):

• Couchbase

• MongoDB

For each of these connectors, a sample configuration file is included with your install of the connector:

• sample.edc-couchbase.properties

• sample.edc-mongo.jvm

Therefore, if SSL is required, proceed as follows to configure the connector:

1. Copy the sample file (e.g. sample.edc-couchbase.properties) and rename it to remove the sample part (e.g. edc-couchbase.properties).

2. Edit the key values within the file as required.

3. Save your changes to the file.

The following article provides guidelines on how to backup and restore your PostgreSQL data:

SYSPRO Embedded Analytics: Disaster Recovery Guidelines

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.

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

If your permissions are not automatically set after importing a template dashboard, proceed as follows:

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

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

   2. Select the Configure function.

      This not only sets up the Embedded Analytics environment, but also re-imports the custom JavaScript file that controls the permission setting events.

   3. Exit the Setup Options program.

2. Open the Embedded Analytics Designer Program: SEADDS program (Program List > Embedded Analytics).

   1. Navigate to the Library and select the imported dashboard.

   2. Make any small change (so that the Save function becomes available) and save your change.

   3. Exit the program.

All future imports and saves will then set the permissions correctly once the system has been updated.

If the Embedded Analytics Designer Program: SEADDS program doesn’t render correctly, it may be due to the configuration of your SQL Server name.

If your SQL Server name is preceded by TCP:, then this results in the program not seeing an active connection to Microsoft SQL Server.

To resolve this, proceed as follows:

1. Open the Setup Options program and navigate to the SQL System Setup form (Setup Options > System Setup > SQL).

2. From the SQL Server name field (within the Company database connection section) remove TCP: from the name.

   For example:

   Original SQL Server name = TCP:JONDOE

   Changed SQL Server name = JONDOE

3. Save your changes and restart SYSPRO for your changes to take affect.

The designer operator can then access the Embedded Analytics Designer Program: SEADDS program once they log back into SYSPRO.

The Embedded analytics designer is 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

Visuals and dashboards allow you to analyze your data in a variety of ways.

• A visual is a single view of data source data.

  These can be stored and added to dashboards using the Visual Gallery.

• A dashboard is a collection of one or more visuals.

  The visuals in a dashboard can be based on one data source or multiple data sources.

A derived field is an in-memory column for your data table that is populated with results from calculations performed on data already in your table:

• You can create derived fields using row-level expressions that are built using row-level functions.

• These calculations are performed at the level of a row, that is, a record, and do not include other data from your table that is outside of that particular row.

• If a source supports derived fields, then you can use them as arguments for aggregate functions when creating other calculations.

• Derived fields can be created from other derived fields.

• Data types are automatically assigned to your derived fields.

Keysets are a more advanced filtering mechanism, as they represent collections of unique data values that can be saved and used in further data analysis across data sources.

Considerations:

• Keysets let you perform multi-pass and multi-source filtering of the data.

• You can create a keyset by selecting a single field for the keyset from visual data.

  Filtering the visual data before creating the keyset limits the unique data values the keyset includes.

• The field you select for the keyset is known as the keyset's key field.

  For example:

  From a visual that lists airport codes nationwide but that has been filtered to show only Virginia airports, you can create a keyset listing only Virginia airport codes by selecting the airport code field as the keyset's key field.

• You can create and update a keyset in various ways:

  • From the Visual Result Set

  • From a Data Point

  • From a CSV File

• You can apply a keyset as a visual filter to limit the visual's result set to records containing values stored in the keyset.

• Keysets can be applied as filters to other visuals that use the same or different data sources. However, the data source for the target visual must contain a field storing the same kind of data as the keyset's key field.

• When working with multiple filter types on the same visual, row-level filters (including wildcard filters) are applied first to a visual, keyset filters are applied second, and group filters are applied last on the aggregated result set.

You can apply row-level, group or saved filters (to narrow the scope of the data in a visual) from the Visual Gallery panel, or from within the Dashboard Designer.

The remainder of this FAQ focuses on adding filters from the Visual Gallery.

Applying a row-level filter

1. From the Embedded Analytics Designer Program: SEADDS program, navigate to the Visual Gallery panel and select the visual against which you want to define a filter.

2. Select the (i.e. Filters) icon from the Sidebar Customization Options.

3. Select the Add Filter function.

4. From the Row tab, select the filter attribute, number, or time field that you want to use from the list.

   You can also select the icon against either of these sections to access the Derived Field Editor or the Custom Metrics Editor to create or modify derived fields and custom metrics to be used as filters.

   The process of creating a row-level filter varies based on the type of field you select:

   • Using an attribute field as your filter:

     This lets you filter visual data by the values in an attribute.

     1. Select the filter attribute that you want to use from the list of available attributes.

        A second page with three tabs appears in the Filters sidebar.

     2. From the Value tab:

        • Indicate a filter operator (Include or Exclude, depending on whether you want to include or exclude the value from the data).

        • Indicate an optional custom value.

          To create and select a custom value, enter the value in the Customize field and select Add. Your custom field is added and selected in the list of possible values.

          To remove the custom value, uncheck it in the list of possible values. It is removed from the filter and from the list of possible values for the filter.

        • Select one or more values from the list of available values for the attribute you selected, or use the Select All function to select all values.

          Quickly find a value by typing the name of the value in the Search bar to limit the list of values.

          A maximum of 1000 values are listed.

     3. From the Wildcard tab, specify a wildcard filter for the attribute.

     4. From the Keyset tab, select a keyset filter for the attribute.

   • Using a numeric field as your filter:

     This lets you filter visual data by the values in a numeric field.

     1. Select a numeric field that you want to use from the list of available number fields.

        A second page with two tabs appears in the Filters sidebar.

     2. The Range tab initially shows the full range of values available. It provides an Operator selection box and From and To boxes for you to use to select the range of values.

        • Select a relational comparison operator in the Operator selection box.

          Data is included in the visual when the data in the filter field meets the condition set by the relational operator and the numeric values you specify.

        • Use the arrows in the From and To boxes to increase and decrease the maximum and minimum values.

     3. From the Keyset tab, select a keyset to apply as the filter.

   • Using a time field as your filter:

     This lets you filter the time range displayed on the visual.

     1. Select a time field you want to use from the list of available time fields.

        A second page with two tabs appears in the Filters sidebar.

     2. From the Range tab, use the From and To boxes to specify the time range for the filter.

        You can set the range in static time or dynamic time, or use variables. Alternatively, you can use the preset ranges provided.

        • If you select Static Time, the From and To boxes are filled with default dates and times. Use the boxes to select specific from and to times.

        • If you select Dynamic Time, the From and To boxes are filled with Start of Data Set and End of Data Set automatically. Use the Condition boxes to select different dynamic from and to times.

     3. Alternatively, select a keyset from the Keyset tab to use for the filter.

5. After the filter specifics have been provided, select the Continue function.

   If you created the filter at the dashboard level, its applied to all the visuals in the dashboard. Otherwise, it is applied only to the selected (i.e. active) visual.

   A number appears in a green circle next to the filter icon on the visuals to which the filter has been applied. The number represents the number of filters applied to the visual.

6. Select the Save function to save your changes to the visual.

Applying a Group level filter

You can use group filters to filter the aggregated result set of a visual. Group filters are filters based on metrics and custom metrics, rather than fields (row-level filters).

Considerations:

• The Group tab is not available if you are using the dashboard filters sidebar.

• Group filters are applied in the same way row-level filters are applied.

• Using group filters, you can filter on saved custom metrics that are not applied to your visual.

• Metrics and custom metrics can also be limited at the data source level.

• If the Filters sidebar does not display all fields, refresh the field at the data source to display all elements within the data.

• The following visual styles don't support group filters:

  • Arc gauges

  • KPI charts

  • Histograms

  • Marker maps

  • Tables of raw data

• Global dashboard filters don't include group filters that may be applied to the visuals in the dashboard, even if all the visuals on the dashboard use the same data source.

• You cannot apply a group filter to your dashboard; only row-level filters (and keyset filters) can be applied globally to a dashboard.

To filter your data by custom metric, proceed as follows:

1. From the Embedded Analytics Designer Program: SEADDS program, navigate to the Visual Gallery panel and select the visual against which you want to define a filter.

2. Select the (i.e. Filters) icon from the Sidebar Customization Options.

3. Select the Add Filter function.

4. From the Group tab, select the Number and Count Of as required for your filter.

5. After the filter specifics have been provided, select the Continue function.

6. Select the Save function to save your changes to the visual.

You can design your dashboard to refresh either manually with user interaction, or by itself whenever the data changes. For automatic refreshing, the Live Mode and Playback options must be enabled within the source configuration's Time Bar settings.

To design your dashboard to refresh automatically, proceed as follows:

1. From the Sources panel of the Embedded Analytics Designer Program: SEADDS program, locate and select the applicable source configuration.

2. Navigate to the Fields tab and locate the applicable Time field on which you want to base the time-lapse refresh.

3. Ensure the following settings are defined against the field, as per your requirements:

   • Granularity

     This lets you define the granularity of the data's refresh rate.

   • Partition (unless your time field includes an Index)

     This lets you define a partition for the field by entering the Partition Field and Partition Function.

     Certain connectors support partitions which allow you to link a partitioned field to another field to help improve the performance of filtering operations for a data source.

4. Navigate to the Global Settings tab.

5. Ensure the following settings are enabled (or defined) against the source configuration:

   • Time Bar

     This lets you enable or disable the time bar on new visualizations by default.

     The options associated with this setting determine the default time field to be used for new visuals, which allows users to view trend reports from any visual.

     • Enable to allow setting of time bar related global settings here, and to enable the time bar on visuals by default. Users can then disable the time bar for individual visuals as needed.

     • Disable to prevent setting of time bar related global settings and to disable the time bar on visuals by default. Users can then enable the time bar for individual visuals as needed.

   • Default Time Attribute

     This lets you indicate an available time field to use, by default. The options vary based on the time field in your data source.

   • Playback

     This lets you play back your data (like a data DVR).

   • Live Mode

     This lets you automatically refresh the data from your data source, based on the refresh rate and delay.

Once the above configuration is defined, your dashboard will reflect the visual time bar as Live (by default this is shown in the bottom right corner) along with its refresh rate.

If your dashboard links all its visuals to the same time bar, then all visuals are refreshed asynchronously.

Yes, you can apply multiple filter controls to visuals within a dashboard, by following these steps:

1. Add the filter controls to the dashboard (that already contains the visuals).

2. Select the Dashboard interactions icon.

   The Dashboard Interactions window is displayed.

   A cross source link is listed in the Links section of the Dashboard Interactions window for every filter control on the dashboard.

3. Select the cross source link where you want to select a specific field for filtering.

4. The different data sources are listed at the Sources section, one of which will be data source of the filtering control.

5. At the Field name, select the field against each data source that you want to use for filtering.

   The selected field name should be the same across all data sources.

6. Close the Dashboard Interactions window.

If your dashboard contains visuals that are made up of two or more data sources, then the filter (e.g. the time line) will only apply to the visual that is currently selected.

Applying a filter across all visuals involves a two-pronged configuration process, in which you first link the data sources (this is referred to as cross visual linking) and then apply the filter to the visualisations in the dashboard.

Cross visual linking refers to linking visuals in a dashboard that may have multiple data sources. This is typically done so that a filter can be applied to all visuals within a dashboard.

Applying a filter across all visuals involves a two-pronged configuration process, in which you first link the data sources (this is referred to as cross visual linking) and then apply the filter to the visualisations in the dashboard.

Follow these steps to link visuals within one dashboard by connecting the different data sources:

1. Open the dashboard within the Embedded Analytics Designer Program: SEADDS program.

2. Select a visual in the dashboard.

3. Select the Dashboard interactions icon.

   The Dashboard Interactions window is displayed.

4. Select the Cross-Source Links option.

5. Select the Add Link button to link the data sources.

   The current dashboard is displayed at the Links section on the left.

6. In the Link Details section on the right you have to create a link by doing the following:

   1. Add a name for the link at the Link Name field and select it.

   2. Select the data source you want to link to at the Source Name field.

   3. Select the data source field you want to link to at the Field Name field.

      All the available fields within that data source will be displayed.

   4. Select Add Source to select the second data source.

      A new row is displayed.

   5. Select the second data source at the Source Name field.

   6. You will notice that only fields with the same data type are listed within the Field Name drop-down, i.e. if you have selected a date field at the previous data source, then only date fields within this data source are displayed.

   7. Select Apply to save the cross source linking.

      You have now configured the link between the data sources.

7. Close the Dashboard Interactions window.

8. Select the first button on the Time bar. The description on this button changes depending on the field that is used for the filtering.

   The Datasources pop-up window is displayed.

9. In the Applies to section, select multiple cross visual links to ensure that the visualizations all apply the same filter.

10. Save your changes.

Linking to another dashboard is useful when you want to select a data point in one dashboard to drill down and view more information of the selected data in another dashboard. Depending on the data, this may involve filtering the data on the target dashboard.

Follow these steps to link a source dashboard to a target dashboard:

1. Open the dashboard within the Embedded Analytics Designer Program: SEADDS program.

2. Select the data point in the visual.

3. Select the Dashboard links gears icon.

   The Dashboard Links window is displayed.

4. Select the Add Link button.

   The Select Link window is displayed.

5. In the Visuals section on the left, select the source visual that you want to link up and in the Dashboard section on the right, select the target dashboard you want to link to.

6. Select Apply to save the link and close the Dashboard Links window.

   Your dashboard within the Embedded Analytics Designer Program: SEADDS program is displayed.

7. Select the Save icon to save your dashboard changes.

8. You can then select the data point in the source dashboard to display a wheel of options.

9. Select the Link option to view the visuals in the target dashboard.

The standard template dashboard packs (supplied by SYSPRO) are shipped with the product and stored within the \Base\Samples folder.

Custom template packs (created by third-party developers) can be stored within the \Work\Analytics folder on the SYSPRO Application server (i.e. you can't export a pack to a client-side folder).

Each dashboard pack contains the following:

• Dashboard configuration file

• All Business Activity Queries used by the dashboard's visuals

• Metadata file containing details about the pack

• PDF document with detailed information pertaining to the dashboard within the pack

  Certain dashboards contain specific caveats in their use, which is explained, alongside the key metric definitions for each visualization on the dashboards.

To create an Embedded Analytics dashboard pack and export it (along with all its related files), proceed as follows:

1. Open the Embedded Analytics Export Program: SEAEXP program (Program List > Embedded Analytics).

2. From the Dashboard listview, select the applicable dashboard that you want to export.

3. Once selected, navigate to the Action column and select the Details function against the dashboard.

   This opens the Embedded Analytics Pack Details Program: SEAPDE program, from where you can view the meta data associated with the selected dashboard.

   In addition, the BAQ details pane indicates all Business Activity Queries that are used by or associated with the selected dashboard pack.

4. Within the Pack details form, update the entries as required:

   1. Name and Description:

      Leave as is, or edit as required.

      The more descriptive you are in your naming convention and description, the easier it is for other users to identify and understand the purpose of the dashboard pack.

   2. Owner:

      Indicate the user responsible for the dashboard pack creation.

   3. Documentation:

      Upload a PDF document to provide all the related details for the dashboard pack.

      This allows the creator of the dashboard pack to provide:

      • Documentation about the pack and what it hopes to achieve

      • What visuals are included within the dashboard

      • What users should expect to see in within the dashboard.

      Use the Preview function to view the document using the Document Viewer Program: IMPVWR program.

   4. URL:

      Optionally indicate a website for more information about the dashboard author or their company.

5. Select the Save function to record your changes.

   You are returned to the Embedded Analytics Export Program: SEAEXP program.

6. Select the Export Selected Dashboards toolbar function.

   This exports each pack in its entirety to a zip file (which includes all of its related files) with a seax extension.

   This zip file is exported to the \Work\Analytics folder on the application server.

   Considerations:

   • If the pack name already exists, a subscript is added to the end of the file name (e.g. Financial_Manager(1).seax).

   • The following characters are replaced in the file name:

     • All spaces are replaced by an underscore (_)

     • All semicolons are replaced by a dash (-)

7. Exit the program.

To import an Embedded Analytics dashboard pack (along with all its related files), proceed as follows:

1. Open the Embedded Analytics Import Program: SEAIMP program (Program List > Embedded Analytics).

   You are presented with a list of all Embedded Analytics dashboard packs found within the following folders on the application server:

   • \Base\Samples

   • \Work\Analytics

2. From the listview, select the applicable dashboard that you want to import.

3. Once selected, navigate to the Details column and select the Details function against the dashboard.

   This opens the Embedded Analytics Pack Details Program: SEAPDE program, from where you can view the meta data associated with the selected dashboard.

   In addition, the BAQ details pane indicates all Business Activity Queries that are used by or associated with the selected dashboard pack.

4. Within the Pack details form, you can optionally preview the PDF document saved against the Documentation field.

   This allows the creator of the dashboard pack to provide:

   • Documentation about the pack and what it hopes to achieve

   • What visuals are included within the dashboard

   • What users should expect to see in within the dashboard.

5. Exit the Embedded Analytics Pack Details Program: SEAPDE program to return to the Embedded Analytics Import Program: SEAIMP screen.

6. Select the Import toolbar function.

   The import process creates the required connections, sources and visuals it needs to populate the dashboard.

7. Exit the program.

Imported dashboards are displayed in the Library of the Embedded Analytics Designer Program: SEADDS program, with the operator that imported the pack listed as the Author for that dashboard. From there you can modify and tailor the dashboard according to your requirements.

Contextual analytics are possible when you link an Embedded Analytics dashboard to key program fields or key form fields (within either the SYSPRO Desktop or SYSPRO Web UI (Avanti) application).

As data forms within SYSPRO are refreshed with new information, the associated key field(s) are promptly passed to the embedded dashboard. Consequently, the dashboard undergoes a refresh, precisely tailoring the analysis to adhere to the applied filter(s).

The convenience of these dynamic filters adapting to your context within SYSPRO eliminate the need for manual filtering.

Considerations:

• A dashboard embedded within a SYSPRO program can have a maximum of five (5) mapped fields (i.e. dimensions) impact and influence the dashboard on the fly.

• Users cannot undo or reverse the filters associated with a dashboard defined with filter mappings. Whereas, users can set filters at runtime when no filter mappings are defined for the dashboard.

• Contextual analytics can also be defined within programs created using the Application Designer.

Before being able to utilize the contextual analytics capability, you must first design your Embedded Analytics dashboard with multiple dimensions, as required.

The following then explains the process administrators can follow to place this dashboard into a SYSPRO program with contextual capabilities:

1. Log into SYSPRO 8 2023 or later.

2. Navigate to the program in which you want to embed the dashboard.

   For example:

   Inventory Query (i.e. INVPEN)

3. From the program's toolbar, launch the Visual Designer Program: IMPFRZ by selecting Design Web View from the Customize icon.

   This allows you to design the program's existing template web view and embed the dashboard.

   For example:

   Within the Inventory Query program, select the Primary Layout from the Design Web View option. Then select to use the existing template for the program.

4. Once the Visual Designer Program: IMPFRZ program is launched, proceed as follows:

   1. Select the Add layout section option.

   2. From the Configure new layout section screen, select the Embedded Analytics card.

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

   4. Within the Filter mappings section, select the key fields to which you want to link within the dashboard (i.e. create the link). These mapped fields are then used to filter the dashboard data at runtime.

      Once you've selected the Key Field, select the matching Dashboard Field.

      For example:

      Key field = StockCode

      Dashboard field = stockcode

      Using the Add new row function, you can define up to 5 mapped fields.

      The Delete function lets you remove a field mapping.

   5. Select the Add Section function.

   6. Move the newly added dashboard card to your preferred location and size it according to your requirements.

   7. Save the layout and close the application.

5. Exit the program.

This newly designed layout, including the contextualized dashboard, will be available within that program when you next log in. The mapped filters are then dynamically set to equal the SYSPRO Key field values during runtime when the page is refreshed.

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.

Yes, you can connect to any Microsoft SQL or PostgreSQL database, thereby enabling data analysis and blending with other data.

SYSPRO Embedded Analytics further compliments the capabilities that the following features provide by allowing you to analyze their data:

• Dimension Analysis

• Group Payments

• Kanban Automated Replenishment

• Sales Pricing Engine

The following data connectors are included with your installation of SYSPRO Embedded Analytics:

• Microsoft SQL Server

• PostgreSQL

In addition, SYSPRO Embedded Analytics enables for seamless blending of SYSPRO data with big data providers of cloud-based data stores. Therefore, the following data connectors can be included with your installation:

• BigQuery

• Cloudera

• Couchbase

• Hive

• MongoDB

• Presto

• Amazon Redshift

• Amazon S3

• Spark SQL

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 Embedded analytics designer is 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 listview (or data table) which represents the data behind the dashboard visual.

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

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

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

   Ensure that you are not currently logged into a role before proceeding.

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

3. Select the role against which you want the workspace (and its associated dashboards) 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: IMPFRZ program is launched:

   1. Select the Add layout section option.

   2. From the Configure new layout section screen, 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. Move the newly added dashboard card to your preferred location and size it according to your requirements.

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

Process to follow when embedding your dashboard within a program's web view in the SYSPRO Web UI (Avanti):

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

   Ensure that you are not currently logged into a role before proceeding.

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

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

4. Select the section in which you want the dashboard to appear.

   A Primary layout is used in this example.

5. This launches the Visual Designer Program: IMPFRZ, from where you are prompted to confirm if you want to use the program's template (if an existing template applies to the program).

   For the purposes of this scenario, select Yes to proceed.

   1. Select the Add layout section option.

   2. From the Configure new layout section screen, 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. Move the newly added dashboard card to your preferred location and size it according to your requirements.

   6. Save the layout.

6. Exit the program.

The dashboard card is then visible for all users when they next log into the SYSPRO Web UI (Avanti) and access that program.

Process to follow when embedding your dashboard within the main menu of the SYSPRO Desktop UI:

Process to follow when embedding your dashboard 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.

   Then indicate the section in which you want the dashboard to appear.

   A Primary layout is used in this example.

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

   1. Select the Add layout section option.

   2. From the Configure new layout section screen, 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. Move the newly added dashboard card to your preferred location and size it according to your requirements.

   6. Save the layout.

4. Exit the program.

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

Process to follow when embedding your dashboard using the Application Builder program in the SYSPRO Desktop UI:

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

   Ensure that you are not currently logged into a role before proceeding.

2. Open the Application Builder program (SYSPRO Ribbon bar > Administration > Customization).

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

   If a web view doesn't yet exist, you are prompted to confirm which type of web view you want to create. Select SYSPRO Client to proceed.

4. This launches the Visual Designer Program: IMPFRZ and displays the current layout if one exists for the program.

   1. Select the Add layout section option.

   2. From the Configure new layout section screen, 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. Move the newly added dashboard card to your preferred location and size it according to your requirements.

   6. Save the layout.

5. Customize your application as required and save your changes.

6. Exit the program.

When your users next log into the SYSPRO Desktop, the newly built application will be available for them to select.

SYSPRO Ribbon bar > Setup

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

Embedded Analytics (Setup Options > System Setup > Connectivity)

• Analytics 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: SEADDS 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

  • Program web views

• SYSPRO Desktop:

  • Main Menu

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

Program List > Embedded Analytics

This program lets you import SYSPRO Embedded Analytics Dashboard packs (both standard and custom types) and all the associated files required to render the dashboard.

Program List > Embedded Analytics

This program lets you create and/or maintain Dashboard Packs for SYSPRO Embedded Analytics (both standard and custom types) by exporting the required dashboard files.

This migration capability enables you to seamlessly export your dashboard (and all its associated files) from one SYSPRO instance, for importing into another.

(Accessible from the Details function of the Embedded Analytics Export and Embedded Analytics Import programs)

This program lets you view or maintain the meta data associated with a Embedded Analytics dashboard pack.

The Query SYSPRO Embedded Analytics Config Business object: SEAQSO business object returns the SYSPRO Embedded Analytics configuration in the Setup Options program.

The Post SYSPRO Embedded Analytics Config Business object: SEATSO business object creates and updates the SYSPRO Embedded Analytics configuration settings within the Setup Options program.