SYSPRO Embedded Analytics Deployment

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

1. Download PostgreSQL 12:

   1. Navigate to the following URL:

      https://www.enterprisedb.com/downloads/postgres-postgresql-downloads

   2. From the installer listing, locate the latest Version 12 (e.g. 12.14) and select the download icon within the Windows x86-64 column.

      The postgresql-12.xx-x-windows-x64.exe install file (where xx-x indicates the selected version) is placed within your Downloads folder, unless you defined otherwise.

2. Install PostgreSQL 12:

   During the install you will be prompted for a PostgreSQL Password and Port.

   Ensure that you take note of these entries as they are required later during the SYSPRO Embedded Analytics install.

   1. Launch the installer from the downloaded exe file.

   2. From the Installation Directory window, define the installation directory by accepting the default path (or change to suit your requirements).

   3. From the Select Components window, accept the default components enabled:

      • PostgreSQL Server

      • pgAdmin 4

      • Stack Builder

      • Command Line Tools

   4. From the Data Directory window, accept the default pathing provided (or change to suit your requirements).

   5. From the Password window, enter and confirm your preferred password. Make sure that there aren't any extra spaces within your entry.

      Ensure that you take note of this password as it is required later during the SYSPRO Embedded Analytics install.

   6. From the Port window, accept the default port provided as 5432 (or change to suit your requirements).

      Ensure that you take note of this port number as it is required later during the SYSPRO Embedded Analytics install.

   7. From the Advanced Options window, accept the default provided and select Next to proceed.

   8. After reviewing the pre-installation summary, proceed with the install.

   Upon completion, a confirmation screen is displayed and you are given the option to install the Stack Builder.

   The Stack Builder is not needed as it has no relation to SYSPRO Embedded Analytics. It merely provides a graphical interface that simplifies the download and installation process for modules that complement the PostgreSQL installation.

   Disable the Stack Builder install option and confirm to close the installation wizard.

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. For example: AppGateWayPass123 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 is required later when configuring the gateway in the Setup Options program.
   Please enter the SYSPRO Gateway Authentication key	Enter a value for the SYSPRO Application Gateway authentication key. For example: AppGatewayKey321 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 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
   Do you want to upgrade the existing installation	This only applies if you have a prior version of SYSPRO Embedded Analytics installed. Enabling this option upgrades your existing product.
   PostgreSQL Hostname	This indicates the name of the machine on which the PostgreSQL service is hosted. For example: localhost
   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 Embedded Analytics Consul Server Port	Indicate the SERVER port on which the Zoomdata_consul service will be hosted. Default port number provided: 30803 Accept the default provided or change manually to match your preference.
   SYSPRO Embedded Analytics Consul Lan Port	Indicate the LAN port on which the Zoomdata_consul service will be hosted. Default port number provided: 30804 Accept the default provided or change manually to match your preference.
   SYSPRO Embedded Analytics Consul Wan Port	Indicate the WAN port on which the Zoomdata_consul service will be hosted. Default port number provided: 30805 Accept the default provided or change manually to match your preference.
   SYSPRO Application Gateway Endpoint	This indicates the hosting endpoint for the SYSPRO Application Gateway service. For example: http://localhost:30800
   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. For example: AppGatewayKey321
   Data Connectors	Select the applicable cloud based data connectors that you want included within your installation: BigQuery Cloudera Couchbase Hive MongoDB Presto Amazon Redshift Amazon S3 Spark SQL MemSQL Snowflake MySQL Oracle

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

   For example:

   AppGateWayPass123

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 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. Within the Embedded Analytics section, ensure that the Embedded Analytics enabled option is enabled.

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

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

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

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

8. Save your changes and exit the program.

9. Restart SYSPRO for your changes to take affect.

Operator Permissions

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.

Designer Program Access

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

• To define Embedded Analytics Designer Program: SEADDS access by role:

  Apply access control against the operator's group within the Operator Groups program (SYSPRO Ribbon bar > Setup).

• To define Embedded Analytics Designer Program: SEADDS access by group:

  Apply access control against the operator's role within the Role Management program (SYSPRO Ribbon bar > Setup).

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:

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

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

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.

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

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

SYSPRO Embedded Analytics: Disaster Recovery Guidelines