Syniti Solutions Upgrade Manual 8.0.6

Overview

IMPORTANT: Clients running the Stewardship Tier in 32-bit mode are recommended to switch to 64-bit mode prior to upgrading to version 8.0.6 to allow sufficient testing before upgrading. If issues occur during the switch to 64-bit mode, it is easier to roll back the architecture switch than the entire upgrade.

The following steps assume a working Syniti Solutions instance is installed. It is never advisable to attempt to upgrade a broken or non-functional instance with the goal of fixing it.

NOTE: Version 7.1 introduced a new centralized security model and users of Data Quality, Master Data Management and Mass Maintenance must update security roles when upgrading to 7.1 and later. Refer to the Syniti Solutions Centralized Security Migration Manual for important information about using security in the Syniti Solutions in version 7.1 or later. Consult this manual BEFORE upgrading to 7.1 or later.

NOTE: Only upgrades from 6.0 and later are supported; there is no upgrade from version 5.x products available.

NOTE: When upgrading to a Stewardship Tier version 7.4.2 and later, please be aware that any JavaScript content added is stripped away and any remaining, safe HTML is displayed to users. Refer to the Unsafe HTML/JavaScript removed in Stewardship Tier 7.4.2 Knowledge Base article for more information.

NOTE: After upgrading to 7.4.5 and later, clients may need to increase their data source timeouts if there are timeout issues when executing rules in Transform. Edit the Command Timeout field on the Vertical View of the Data Sources page in System Administration.

NOTE: If psaCollate is installed on the instance you are upgrading, you must uninstall it before upgrading to 8.0.6. The collation technology is included in the product in 7.4.5 and later. To uninstall psaCollate refer to the Knowledge Base Article Uninstalling psaCollate Prior to Upgrade.

The upgrade process will upgrade all components of Syniti Solutions, including all delivered WebApps. The upgrade may fail if any of the delivered components have been customized.

A customization is a change to the underlying source code, which differs from configuration, a normal setup of the software, such as setting up workflows and defining parameters via the configuration pages.

The upgrade does not modify any existing Construct pages or menus.

Custom CTS Configurations

WARNING: Any additions or changes users have made to CTS configuration (Admin -> CTS ->Configuration) may be lost when upgrading from DSP 6.6.x or earlier.

Prior to any upgrade backups should be taken of all databases. Once the upgrade is complete, if any custom CTS configurations are found to be missing, then the backup of the CranSoft database should be restored to a new database (DO NOT restore it to the CranSoft database). The missing custom configurations can be merged into the CranSoft.dbo.CTSConfig% tables from the restored backup.

Please contact Syniti Support if you would like assistance with this activity.

Preserve Customizations

WARNING: Customizations made to any component of the delivered Syniti Solutions will be overwritten in this upgrade. To preserve customizations, make a copy of the customizations prior to applying any upgrade.

Upgrading from a 6.0.x Version

If you are upgrading from a 6.0.x version,

  1. Enter a ticket at Syniti Supporto request the 61UpgradeTargetERPTableCheck.sql script. This script detects problems with targets, for example if the ERP table name is different between 6.0.x and 6.6.
  2. Run the 61UpgradeTargetERPTableCheck.sql prior to upgrading from 6.0.x to 6.6.

If the query detects problems, open a ticket with Syniti Support.

Syniti Solutions version 6.0 or later must be installed. Do not attempt to perform the upgrade process on any Syniti product prior to version 6.0.

NOTE: To identify the currently running version of the Syniti Solutions framework, log in and look at the footer.

Version 6.5 introduced the restriction that a license key is tied to a single server and cannot be used on any other server. In order to enforce this restriction, starting with version 6.5 a hardware ID must be generated on the application server where the Syniti Solutions is installed which must accompany the request for a new license for that instance. Obtaining a license file is therefore now a two-step process described in the Install a Permanent License section. Until the new licenses are applied, the upgraded site will not be functional.

How to Request a New Product License File

  1. Navigate to the location of the Hardware Identifier program called “HardwareIdentifier.exe” downloaded automatically with the SST<Version>FullPackage.exe installer.

  2. Right-click the program file and select Run as Administrator.
  3. Click Generate.

  4. The Hardware ID field populates.
  5. Click Copy to copy the automatically generated ID.
  6. Include the automatically generated ID along with the Windows computer name of the server and your Company name in an email to licenserequests@syniti.com, with the subject “Product License Request”.

    NOTE: A license file will be sent as an attachment to an email you will receive in response within two business days.

NOTE: If the upgrade includes the addition of a Syniti Knowledge Platform subscription contact Syniti Support.

Align Column Encryption State for key Target Source column in Collect Before Upgrade

NOTE: Version 7.1.3 runs post-installation scripts that create a new Common Data Source Registry entry of type SAP Application Server and then assign this record to the associated Collect Target Source record. If the same SAP Application / Client is registered on multiple Target Source records, duplicate records will be created in the Data Source Registry. Users should be aware of this change and review the created data sources post installation to ensure that there are no duplicate entries in the Data Source Registry. Review this section BEFORE upgrading from 7.1.2 or earlier versions.

A new feature was introduced in SST 7.1.3 whereby the SAP connection settings on a Collect Target Source are moved to a dedicated Data Source Registry record. During upgrade, the following DataGarage dgTargetSource table columns are used to create the new DSPCommon Data Source Registry records.

Database Table Column Database Table Column
On upgrade, the data in these columns is copied from... ... to these columns
DataGarage dgTargetSource SAPPassword DSPCommon ttDataSourceRegistry SAPPassword
DataGarage dgTargetSource SAPUserID DSPCommon ttDataSourceRegistry SAPUserID
DataGarage dgTargetSource RfcNameSpaceOption DSPCommon ttDataSourceRegistry RfcNameSpaceOption
DataGarage dgTargetSource SAPServerHost DSPCommon ttDataSourceRegistry SAPApplicationServer
DataGarage dgTargetSource Language DSPCommon ttDataSourceRegistry SAPLanguage
DataGarage dgTargetSource SAPMsgServerHost DSPCommon ttDataSourceRegistry SAPMessageServer
DataGarage dgTargetSource SAPLogonGroup DSPCommon ttDataSourceRegistry SAPLogonGroup

As a result of these changes, BEFORE UPGRADING to version 7.1.3 and later, you must review and confirm that the encryption state of these two sets of columns matches. If you do not confirm that the encryption state is identical in these two sets of columns, mixed data could be saved in the column when the Syniti Solutions is upgraded. Access the Data Source Column Encryption page in System Administration. The Status field indicates issues with encryption that must be corrected before upgrade.

Before Proceeding with the Upgrade

IMPORTANT: Review the Knowledge Base article Installation Requirements Check Tool to ensure all prerequisites have been met before starting the upgrade.

Prior to starting the upgrade process, it is important to perform the following preparatory steps:

  1. Stop Syniti Solutions Services

    The installer does not stop the service automatically, so you must stop all background services in use by the Syniti Solutions instance.

    Users will be unable to access the web server while the upgrade is being performed; it may be appropriate to warn users in advance of the temporary unavailability of Syniti Solutions. Use the Services console to stop the Syniti Solutions service(s); do not use the CranSoft Configurator.

    To stop the services:

    1. Open Windows Start Menu.
    2. Select Administrative Tools.
    3. Run Services.
    4. Right-click the Syniti Solutions service.
    5. Select Stop.
    6. Repeat the previous two steps for any additional Syniti Solutions services.
  2. Stop Web Services

    Web services must be stopped for the duration of the upgrade.  This process disconnects all active users, so it is highly recommended to perform the upgrade when no users are on the system. This process stops IIS on the web server. 

    To stop the Web services:

    1. Open Windows Start Menu.
    2. Open the Command Prompt.
    3. Type: IISReset –stop.
    4. Press the Enter key.
    5. Leave the Command Prompt window open for later use.
  3. Back up all Syniti supplied databases or verify that a complete recent backup already exists.

    Supplied databases:

    cMap, cMass, Console, ContentMaster, CranPort, CranSoft, DataConstructionServer, DataDialysis, DataGarage,  DSPCommon, DSW, Integrate, IntegrateStaging, InterfaceServer, MC, RADToolkit, dgSAP and dgReports

  4. Back up the <Syniti Solutions Installation path>\BOA\DSP directory in Windows to a compressed zip file.
  5. Confirm that administrative rights are available on the Web Server.
  6. Unzip the installation package that was downloaded from Syniti and place the Setup.exe file for the new version on a local drive of the web server.
    1. Right-click the Setup.exe and select Properties.
    2. Click the Unblock button, if present.
  7. Identify the installation directory that was used for the initial setup of Syniti Solutions. This can be determined by reviewing the Physical Path parameter on the Basic Settings of the Application/Virtual Directory in IIS Manager.

    NOTE: Do not include the BOA\DSP\Web portion of the path.

    NOTE: The installation will fail or an additional copy of the Syniti Solutions will be installed if the correct path to the existing installation is not specified. Examples of the Physical Path are:

    • C:\Program Files (x86) – this is the default path
    • D:\

If Experiencing Deadlock Issues

If experiencing deadlock issues, enable the Is Read Committed Snapshot On and the Allow Snapshot Isolation settings in SQL Server for all delivered databases. Refer to the Minimize Deadlocks Between Read and Write Operations knowledge base article for more information.

Perform the Upgrade

NOTE: Ensure .NET 4.8 is installed prior to upgrading the Syniti Solutions and that the server has been restarted after that installation.

To upgrade the Syniti Solutions:

  1. Right-click the SSTXXXPackage.exe file.
  2. Select Run as Administrator; the Syniti DSP Setup window displays.
  3. Click the Options button and compare the suggested Install location with the Physical Path identified in the preceding section. The Install location will only show the first part of the path, that is, with BOA\DSP\Web removed. Modify the Install location parameter as appropriate to ensure that the location matches that of the instance that is to be upgraded. For example, if the Physical Path identified in the previous section is D:\BOA\DSP\Web, then the Install location should be set to D:\ (see screenshot below). If the Physical Path is C:\Program Files (x86)\BOA\DSP\Web then the Install location should be set to C:\Program Files (x86)\.

    NOTE: If you are unclear at this point, do not proceed. Instead, open a Support issue at Syniti Support.


  1. Click OK in the Setup Options dialog.
  2. Click the Install button.
  3. When a Setup Successful dialog displays, click the Close button; a Package Manager window opens automatically and the following message displays:

  4. Wait while the unpacking process completes. Do not interrupt this process.
  5. After unpacking completes and there are no issues, the upgrade proceeds automatically without any user input being required. Wait until the upgrade completes. This process may take up to an hour to complete – do not interrupt this process.
  6. Do not close the Package Manager console until the installation is complete and the DBMoto InstallShield Wizard is displayed.
  7. When prompted by Syniti Data Replication InstallShield Wizard, follow the steps in Syniti Data Replication Upgrade for the Stewardship Tier.

Syniti Data Replication Upgrade for the Stewardship Tier

Syniti Solutions 8.0.5 and later are certified with Synti Data Replication 9.8.3.1.2, both of which are certified on Windows Server 2022.

 

On Syniti Solutions upgrades, the existing Syniti Data Replication installation is detected (either 32-bit or 64-bit) and the Syniti Data Replication setup file for the platform bit type currently installed is executed to perform an upgrade of Syniti Data Replication.

NOTE: Syniti Data Replication versions prior to 9.5.5 are assumed to be 32-bit when determining the upgrade logic.

If currently running Syniti Data Replication 64-bit, run the Syniti DR 64-bit setup.exe, regardless of Syniti Solutions mode.

If currently running older versions of 64-bit Syniti Data Replication, manually run the setup.exe installer, located in the {installationDirectory}\DSP\Packaging\Packages\DSP.SynitiDR-{latest version}\SynitiDRInstaller folder.

Before proceeding to the upgrade:

  1. Stop Syniti Data Replication Agent if running.
  2. Save a copy of the metadata by right-clicking the metadata node DBMoto_meta and selecting 'Backup Metadata'.

    NOTE: If the connection and replications are changed during the upgrade process, contact Syniti Support to restore this information using this back up.

  3. Stop the Syniti Data Replication Management Center, Server Agent and the Syniti Data Replication Service Monitor.

Upgrade Syniti Data Replication Using the Installation Wizard

NOTE: Ensure .NET Framework v4.8 or higher is installed.

To upgrade Syniti Data Replication using the installation wizard:

  1. Run the installation wizard, which will detect that Syniti Data Replication is already installed on the machine. It will ask if you want to upgrade it; click Yes.

    NOTE: This will upgrade the Syniti Data Replication located in the DBMoto installation folder and not the one in the UserArea folder.

  2. Follow the wizard to complete the upgrade.

    NOTE: The DBMoto.config file may need to be updated in the BOA installation Directory\Web\bin\ExternalAssemblies folder if the Name of The Server defined in Management Center is not "local".

  3. Start the Syniti DR Service Monitor, Replication Agent and Management Center.
  4. Open the DBMoto_Client metadata and verify that you have the same connections and replications as before doing the upgrade. If this is not the case, contact Syniti Support for assistance in restoring the information from the backups performed in Step 2 in the preceding steps.

NOTE: If upgrading to 32-bit from a previous 32-bit version of Syniti Data Replication, an error may occur stating “Unable to read beyond the end of the stream.” This is a known issue in Syniti Data Replication. To work around this issue, click OK on the error message. Navigate to C:\Program Files\Syniti\Data Replication V9\AppData\Metadata\DBMoto_Client and delete the metadata.log file. Return to Syniti Data Replication and expand the metadata folder. If a message displays about updating the license upon expanding metadata for the first time, click OK to continue.

Upgrade Syniti Data Replication Manually

To upgrade Syniti Data Replication manually:

  1. Export the Syniti Data Replication Metadata settings:

a. Open Syniti Data Replication Management Center

b. Expand metadata.

NOTE: If upgrading to 32-bit from a previous 32-bit version of Syniti Data Replication, an error may occur stating “Unable to read beyond the end of the stream.” This is a known issue in Syniti Data Replication. To work around this issue, click OK on the error message. Navigate to C:\Program Files (x86)\Syniti\Data Replication V9\AppData\Metadata\DBMoto_Client and delete the metadata.log file. Return to Syniti Data Replication and expand the metadata folder. If a message displays about updating the license upon expanding metadata for the first time, click OK to continue.

c. Select Backup MetaData.

  1. Make a copy of the dbmoto.config and dbmoto.server.config files in the 32 bit Data Replication folder.
  2. Uninstall the 32-bit Syniti Data Replication installation, located in Control Panel > Programs> Programs and Features> Uninstall a Program.
  3. Run the Syniti DR 64-bit install, located in the {installationDirectory}\DSP\Packaging\Packages\DSP.DBMoto-{latest version}\DBMotoInstaller64\setup.exe folder.
  4. Stop all services and replace the dbmoto.config and dbmoto.server.config files in the Data Replication 64-bit install directory with the files previously saved.
  5. Restart the Syniti Data Replication Server Agent.
  6. Open Syniti Data Replication Management Center and confirm DBMoto server name is unchanged.

Post Syniti Data Replication Upgrade if Using LSA Services

Clients who are upgrading from 32-bit to 64-bit versions of Syniti Data Replication (or vice versa) and are using LSA Services must reconfigure these services using the new installation path:

  1. Open an admin command prompt and run: sc config <service name> binPath= <binary path>.
  2. Ensure that the binary path includes all parameters that are included in the service path. For example, an existing LSA service called "DBMoto_LSA_SQL" may have the following exe path:

"C:\Program Files\Syniti\Data Replication V9\DBMLogReaderAgent.exe" "sqlserver" "E:\DevBox\LSA\SQL" "pfx"

  1. Change the service using the following command:

sc config DBMoto_LSA_SQL binPath= "\"C:\Program Files\Syniti DR New\DBMLogReaderAgent.exe\" \"sqlserver\" \"E:\DevBox\LSA\SQL\" \"pfx\""

where "C:\Program Files\Syniti DR New" is the new path where the new Syniti Data Replication instance is installed.

NOTE: In order to run the command correctly, the whole list of parameters must be passed using double quotes at the beginning and the end of the whole binary path, and using \ to escape existing quotes.

Post Upgrade Steps

The following post upgrade steps must be completed for the Stewardship Tier to be fully functional.

NOTE: If you are using custom styles for the Syniti Solutions and are upgrading to version 7.0 or later, you must configure the Style Editor with new style properties for your customized stylesheet to display the Syniti Solutions properly. The Styles page in System Administration has been updated with additional options. After upgrading to 7.0 or later, custom styles may have to be updated by an Administrator. Refer to Manage Styles in System Administration online help for more information.

  1. Consult Recommendations for SQL Server Optimizations for information about how to configure optional optimizations for SQL Server.

  1. If you have a Knowledge Tier tenant, refer to Set Up and Configuration for Reporting and Metrics Agent.

  2. Optionally, update the web.config file to specify how long foreground events run. The default is 90 seconds. If the default is not updated, be aware that there is a possibility of timeouts. To override this default installation setting, update the maximum number of seconds that foreground events should run in the new executionTimeout property in the httpRuntime element in the web.config file in the installation directory. The user could also change specific foreground events to run in the background. Refer to the Foreground Events Time Out after 90 Seconds knowledge base article for more information.

Additionally this section contains the following post upgrade steps:

Start Syniti Solutions Services

Each instance of the Syniti Solutions Service must be started to allow the Syniti Solutions to function.

To start the services:

  1. Open Windows Start Menu.
  2. Select Administrative Tools.
  3. Run Services.
  4. Locate the Syniti Solutions service(s).
  5. Right-click the Syniti Solutions service.
  6. Select Start.
  7. Repeat Steps 5 and 6 for each Syniti Solutions service.
  8. Close the Services console.

Start Web Services

To start the Web services:

  1. Open Windows Start Menu.
  2. Open the Command Prompt.
  3. Type: IISReset –start.
  4. Press the Enter key.
  5. Close the command prompt window.

Install Assemblies

Two assemblies must be manually installed.

To install the assemblies:

  1. Navigate to the folder that contains the assemblies.

    NOTE: These assemblies are typically located in C:\Program Files (x86)\SAP\FrontEnd\SAPgui\.

  2. Open a Command Prompt at the folder location.
  3. Run the following commands as an Administrator:
    • regsvr32 sapfewse.ocx
    • regsvr32 saprotwr.dll
  4. Navigate to C:\windows\SysWOW64\ if installing on a 64-bit machine.
  5. Run the regsvr32 msscript.ocx command.

Re-create BAPI Templates

Due to an update in the Integrate.dbo.ttBAPI table to avoid the use of a binary formatter, when upgrading to the Stewardship Tier 7.4.3 or above, clients must re-create their BAPI templates. Failing to do so will cause the posting of a BAPI template to fail with the following error:

An Exception was thrown: The BAPI Template was exported using an older version of the Stewardship Tier which is incompatible with the current 
version.
Please re-create the template by clicking the Create BAPI Template button on the vertical of the Template page.

All BAPI templates must be valid, i.e., the BAPI function exists and the SAP Application Server is accessible.

To re-create BAPI templates:

  1. Select Integrate > Categories in the Navigation pane.

  2. Click the Templates icon for a BAPI category.

  3. Click Vertical View for a template.

  4. Click the Create BAPI Template icon.

Install a Permanent License

To install the permanent license requested in the section: How to Request a new Product License File:

  1. Log in to Syniti Solutions site as an Administrator.
  2. Select Admin > Configuration > Product Licenses in the Navigation pane.
  3. Click the Upload a file icon in the FILE NAME column next to the Upload a New Product License link.
  4. Locate the permanent license file that was received and saved previously.
  5. Click Open.
  6. Verify the license is uploaded.

    NOTE: If the Navigation pane does not display all the licensed components as expected, use the browser refresh button or the F5 key to refresh the screen. At this point the full vertical menu will appear.

Validate the Data Source for Data Quality

To validate the Data Quality data source:

  1. Select Admin > Data Sources in the Navigation pane.
  2. Locate the record with Data Source Name DataDialysis.
  3. Validate the record.
  4. Click the Recompile Objects icon.

Validate the Data Source for Common

To validate the Common data source:

1. Select Admin > Data Sources in the Navigation pane.

2. Check for duplicate SAP Application / Client records.

Grant Database Server Permissions to Permit Dashboard Functionality in System Administration

To grant database server permissions:

  1. In SQL Server Management Studio, right-click the DSP database server, and select Properties.
  2. Under Select a page, click Permissions.
  3. In Logins or roles, select the login used for the Syniti Solutions to connect to the database server.
  4. In Permissions for <login>: on the Explicit tab, scroll to View server state, and then click the Grant checkbox.

Change the Site and Service Platform Type

Installations create the site and service to run in 64-bit processes. Refer to Setting the Site and Service Platform Type to 64-bit if these settings must be updated.

Verify Upgrade Completed Successfully

To verify the upgrade has completed:

  1. Log in to the Syniti Solutions site.
  2. Confirm that the site functions as expected.
  3. Confirm that background jobs are being processed by the Syniti Solutions Service.

Syniti Solutions Upgrade Impact:

When upgrading from DSP 7.1.2 or below to 7.1.3 or above, Collect Target Sources that include SAP connection details will automatically have the saved connection string details converted into a new Data Source of type SAP Application Server. The newly created SAP Application Server Data Source will then be assigned to the Collect Target Source.

After upgrading, it is important to review and test all Collect Target Sources to ensure they function correctly.

Collect Data Services Packages Rebuild

If you are upgrading from a version prior to 6.5.3, and Collect packages have been built using Data Services as the package type (both standard and RFC), then the Collect Packages must be re-built as the naming convention has changed for the Data Services objects (Data Stores, Jobs and Data Flows) to improve integration of the two products. Use the standard Collect Build process to rebuild the Data Services packages, ensuring that you also click the Test Connection icon on the Target Sources page as this process recreates the Data Services Data Store.

Assemble Security Changes

When upgrading to the Stewardship Tier 7.5.0 or above, roles that include an Assemble WebApp group have the Assemble.WorkingDataSources security definition key assigned automatically. This allows users who have access to these roles to create and maintain Assemble packages for all non-delivered data sources.

If the Stewardship Tier installation uses Assemble packages that read from and write to delivered application data sources, then roles and user security must be adjusted to use the Assemble.ApplicationDataSources security definition key. Refer to Set Up Security for Assemble for more information.

Create the Partial Request Rejection Stored Procedure in MDM

NOTE: This section applies when upgrading from 8.0.2 or below to 8.0.3 or above.

Users can add a Rejected and a Rejection Reason column to tasks (pages) for use with partial request rejection. Partial request rejections allow the Review role user to reject only the data that is not correct instead of rejecting all of the records in the request. Refer to Perform a Partial Request Rejection for more information.

As part of configuring this feature, on the Content WebApp page for data entry, the Designer must register the business rule webRequest_Submit_ParentRequestRejectedRecordsIns to that page’s Submit event. This stored procedure gathers information about the request, including whether it has a parent request ID. Refer to Create a Stored Procedure Business Rule for more information. The stored procedure can be generated once per category, when the user clicks the Create Default Web App Request Table and View icon on the Category page’s Vertical View on the Rules and Actions tab.

To retrofit this functionality to existing Content Applications, the stored procedure webRequest_Submit_ParentRequestRejectedRecordsIns must be created in all Content Application databases. This can be done by executing the Partial Request Rejection script.

Upgrade Troubleshooting

Contact Syniti Support for assistance with any errors. When opening a ticket, include the full text of any error message received and a description of what steps were performed leading up to this point.

Installation and Upgrade Supplemental Sections