Syniti Solutions Installation Manual 8.0.6

Overview

This help system provides information on the required Roles and Features that must be installed for Syniti Solutions (formerly called DSP) to function as well as installation steps and post installation tasks. Send feedback or information about errors or omissions to ProductDocumentationTeam@Syniti.com.

The success of the installation is heavily dependent on correct environment preparation. The typical environment is a server pair – one server running Microsoft Internet Information Services (IIS) hosting the Syniti Solutions web site and the other server running Microsoft SQL Server hosting the databases. It is possible for the Web Server and Database Server to be the same physical machine. However, this is not supported for production environments. Also, the Syniti Solutions offers integration points with SAP Data Services and Information Steward. To avoid any potential resource contention, we recommend that these SAP components not be installed on the Syniti Solutions Web Server or Database Server.

After the initial installation of the Syniti Solutions, little maintenance from the administrator is required. Ongoing responsibilities include applying periodic updates to Syniti Solutions, monitoring Internet Information Services (IIS) and SQL Server performance and adjusting site parameters. It is also important to check that service pages configured to clear out stale data from database tables are completing successfully and that index maintenance is performed on the databases to avoid performance degradation over time. Some organizations may divide responsibility for IIS, Syniti Solutions and SQL Server administration depending on the organizational structure. This help system focuses primarily on preparing the environment and installing the Syniti Solutions software.

NOTE: Syniti Solutions software includes the following components:

  • Syniti Solutions (formerly Data Stewardship Platform (DSP))
  • Advanced Data Migration
  • Data Quality (formerly dspMonitor™)
  • Mass Maintenance (formerly dspCompose™)
  • Master Data Management (formerly dspConduct™)

Exclusions

The installation procedure described in this help system provides detailed steps for a straightforward setup on a company intranet where there is no direct access to the Syniti Solutions server from the public Internet. This is the most common deployment scenario for the Syniti Solutions. In most instances, this help system uses default values that may not be considered sufficiently secure for a publicly accessible web site. If recommendations on configuring stricter security settings are required, contact Syniti Support.

Although there are several references to SQL Server settings required by the Syniti Solutions, this help system does not include guidelines for installing Microsoft SQL Server or for managing, backing up and archiving SQL Server databases. These are local functions defined by corporate policies and procedures.

Relevant Documentation

This help system also contains the Syniti Solutions Software Requirements and Hardware Sizing Guide.

The online help is hosted on a Syniti server. To access help, users must be able to navigate to https://dsphelp.syniti.com/*.

Installation Prerequisites

Prior to the installation of the Syniti Solutions, the prerequisites in this section must be satisfied. It is recommended to complete the following sections in order before attempting to install the Syniti Solutions to ensure no required components or settings are missed. The automated nature of the Syniti Solutions setup means that there is no opportunity to fix missing prerequisites during the installation process.

NOTE: If you are upgrading, refer to the Upgrade Overview section for information. If upgrading from a version prior to 6.5 to this version, you must obtain additional product licenses.

Review the Syniti Solutions Software Requirements and Hardware Sizing Guide 8.0.6 section to ensure all required software and hardware requirements have been met, especially the following section.

Windows Server Component Requirements

The following roles and features are required to run the Syniti Solutions on Windows Server. Additional features and roles may be added if desired.

NOTE: IIS components must be installed before the Syniti Solutions setup is run.

Required Roles and Role Services – Windows Server

Web Server (IIS)

  • Web Server
    • Common HTTP features
      • Static Content
      • Default Document
      • HTTP errors
      • HTTP redirection
    • Application Development
      • .NET extensibility 4.x
      • ASP
      • ASP.NET 4.x
      • ISAPI extensions
      • ISAPI filters
    • Health and Diagnostics
      • HTTP logging
      • Request monitor
      • Tracing
    • Security
      • Basic Authentication
      • Windows Authentication
      • Digest Authentication
      • Request Filtering
    • Performance
      • Static Content Compression
  • Management Tools
    • IIS Management console
    • IIS 6 Management Compatibility
      • IIS 6 Metabase compatibility
      • IIS 6 WMI compatibility 
      • IIS scripting tools 
      • IIS 6 Management console 
  • Third-party software
    • SAP GUI version 7.4.3 Patch Level 8, 7.5.2 Patch Level 10, and 7.6.1 Patch Level 1

    • The installation of SAP Data Services Designer Client on the application (web) server is required if working with Data Services Automation. The version must be the same as the Data Services Designer installed in the Data Services server.

This section contains the following topics:

Obtain License

There are two methods for obtaining a license: via email and also via a ticket on support.syniti.com.

NOTE: Users must request a new license under the following scenarios:

  • If upgrading from 7.3.1 or below to 8.0.6 to include the Promote component

  • If upgrading to 7.4.6 to include the Entity Validation component

  • If upgrading to 8.0.5 to include the Remediate component

Obtain a License via Email

  1. Navigate to the location of the Hardware Identifier program (called “HardwareIdentifier.exe") included in a zip file along with the installation software and documentation downloaded from Syniti.
  2. Open the program.
  3. Click Generate.

  4. Copy the automatically generated ID and include it in an email to licenserequests@syniti.com, with the subject “Product License Request” and the following information. All information below pertains to the application server running the Syniti Solutions; no information is needed regarding the database server:
    • Hardware ID (as mentioned above)
    • Windows computer name
    • Number of processor cores (as shown in the Task Manager CPU tab)
    • Usage of the Syniti Solutions instance, i.e., DEV, TEST (or QA) or PROD.

Within two business days, Syniti Licensing will send you an email with a license file as an attachment. Save the file to your local computer and upload it on this page. If problems occur during this process, submit an issue to the product support site.

Refer to Log In to the Syniti Solutions Site for the First Time and Configure Licensing for more information.

Obtain a License via a Support Ticket

Prerequisite: Create a support account and register as a user on support.syniti.com.

  1. Navigate to the location of the Hardware Identifier program (called “HardwareIdentifier.exe") included in a zip file along with the installation software and documentation downloaded from Syniti.

  2. Open the program.
  3. Click Generate.

  4. Copy the automatically generated ID and collect the following additional information. All information below pertains to the application server running Syniti Solutions; no information is needed regarding the database server:
    • Hardware ID (as mentioned above)
    • Windows computer name
    • Number of processor cores (as shown in the Task Manager CPU tab)
    • Usage of the Syniti Solutions instance, as in, DEV, TEST (or QA) or PROD.
  5. Navigate to support.syniti.com. and open a ticket.
  6. Select I need a license for Syniti Solutions (DSP) from the list box.
  7. Enter required information.

Syniti Licensing will deliver the license via the support ticket. Save the file to your local computer and upload it on this page. If problems occur during this process, submit an issue to the product support site.

Refer to Log In to the Syniti Solutions Site for the First Time and Configure Licensing for more information.

Configure Web Browser

The Syniti Solutions is a web browser-based system and has been tested to work with Google Chrome (latest version) and Microsoft Edge; Apple Safari (11) is also supported, though not explicitly certified.

The default settings for most internet browsers meet the requirements for the Syniti Solutions. Cookies must be allowed; JavaScript is used throughout Syniti Solutions and popup windows must not be restricted for the Syniti Solutions site. If problems are experienced accessing the Syniti Solutions web site, relevant settings to enable cookies and JavaScript are usually located in a Privacy or Security section of the browser’s options or preferences settings.

NOTE: Due to browser technology constraints, Syniti Solutions functionality to create BDC Script Integrate templates directly from the Syniti Solutions (Integrate and Mass Maintenance) has been deprecated; however, BDC recordings can still be recorded in SAP and imported into the Syniti Solutions to use this functionality. Additionally, support for the creation of new SAP GUI Integrate templates has been deprecated. Existing GUI Script Integrate templates will continue to work.

Configure SQL Server

Since the Syniti Solutions is running as an Internet Information Services web site, SQL Server authentication must be enabled in SQL Server for the Syniti Solutions to connect to the databases.

To enable SQL Server authentication:

  1. Open SQL Server Management Studio.
  2. Connect Object Explorer to the appropriate SQL Server instance.
  3. Right-click the SQL Server instance.
  4. Select Properties from the list box.
  5. Click the Security tab.
  6. Verify SQL Server and Windows Authentication mode is selected.

    NOTE: When changing the authentication mode, the user may be required to provide a System Administrator (sa) account password.

  7. If changes were made, restart the SQL Server service by right clicking the instance name and selecting Restart.

Configure IIS

IIS protects against the host header being updated and an error may display. Avoid an issue with host heading information leaking by setting the Host Name on the “Default Web Site” IIS bindings.

To configure the IIS bindings:

  1. Open IIS.

  2. Click on the Default Web Site.

  3. Click Bindings.

  4. Click Edit after selecting the binding.

  5. Enter the host name for the site.

  6. Click OK.

Create a SQL Server Login

Once SQL Server authentication is enabled, a SQL Server login must be created. This is the account that the Syniti Solutions uses to log in to the databases.

To create a SQL Server login:

  1. Open SQL Server Management Studio.
  2. Connect Object Explorer to the appropriate SQL Server instance.
  3. Expand the Security folder.
  4. Right-click Logins.
  5. Select New Login from the menu.
  6. Name the login (for example, DSP).

    NOTE: Do not use periods (.) in the login name.

  7. Select SQL Server Authentication.
  8. Enter a password in the Password field.
  9. Re-enter password in the Confirm Password field.
  10. Uncheck the Enforce Password Policy checkbox.

    NOTE: Disabling Enforce Password Policy prevents the password from expiring. An expired password causes the Syniti Solutions site to become periodically unavailable.

  11. Click the OK button to create the login.

Configure Default Database File Locations

To optimize usage of disk space and obtain best performance, data files (mdf, ndf) must be located on a dedicated drive array and transaction log files (ldf) should be located on a dedicated drive array, separate to that used for the data files. Several databases are created automatically during installation and their files will be located based on the default settings defined at the SQL Server. By default, SQL Server creates database files under the C:\Program Files\ folder structure, which is not the optimal location. Change these defaults prior to installation.

To configure database default locations:

  1. Open SQL Server Management Studio.
  2. Connect Object Explorer to the appropriate SQL Server instance.
  3. Right-click the SQL Server instance.
  4. Select Properties from the list box.
  5. Click the Database Settings tab.
  6. Under Database Default Locations, configure the desired folder locations for Data and Log files by entering the appropriate folder paths or by browsing to the chosen location (recommended).
  7. Click OK.

Recommendations for SQL Server Optimizations

Configure settings as follows to tune performance.

Operating System Settings

These settings need to be completed for both the Database server and the Application server.

  • Set Power Mode (Control Panel) to "High Performance"
    1. Open Control Panel > Hardware and Sound > Power Options.
    2. Click Create a Power Plan to build one selecting High Performance.
  • Set System Properties to "Adjust for Best Performance"
    1. Open Settings > System > About.
    2. Select Advanced system settings.
    3. Within System Properties window click select Advanced tab.
    4. Within Performance section click Settings.
    5. Within Performance Options window on Visual Effects tab - click to select Adjust for Best Performance.
  • Configure PageFile.sys size should be 1.5 * Total Memory and located on SSD if possible
    1. Open Settings > System > About.
    2. Select Advanced system settings.
    3. Within System Properties window click select Advanced tab.
    4. Within Performance section click Settings.
    5. Within Performance Options window on Advanced tab.
    6. Within Virtual Memory section - click Change...
    7. Within Virtual Memory window - Deselect Automatically manage paging file size for all drives.
    8. Select Custom Size.
    9. Populate both Initial and Max with same PageFile size (1.5 * memory).

For SQL Server, add SQL User to Security for Perform Volume Maintenance Task

  1. Enter “gpedit.msc” into a run prompt.

  2. Go to the following path: Local Computer Policy > Window Settings > Security Settings > User Rights Assignment.

  3. Find the “Perform Volume Maintenance Tasks” in the list.

    NOTE: If the only group that shows up is “Administrators”, the SQL Server account is missing permissions

AntiVirus Software Exclusions

  • SQL Server Log Files: exclude the LOG folder for each SQL instance
  • SQL Server DB files: exclude *.MDF, *.LDF, *.NDF
  • SQL Trace Files: exclude *.TRC
  • Pagefile.sys
  • SQL Server Back-up Files (i.e., *.bak, *.trn)

Server level settings

NOTE: To access, right-click Server in SSMS > Properties.

  • Set min server memory to 8GB (8192 MB)
  • Set max server memory (based on total Operating System reported memory - 4GB
  • Set Cost Threshold to 75
  • Set Max Degree of Parallelism to 4
  • Set Backup Compression to On

Database Level Settings

Configure System Model database using the following settings:

Go to SQL Databases > System Databases > Model > Properties > Files

  • Size Each Data File to 512 MB, 512 MB Growth
  • Size Log File to 64 MB, 256 MB Growth
  • Set Read Committed Snapshot Isolation to True
  • Set Recovery Mode to Simple

NOTE: It is important that this step be executed BEFORE the creation of the CranSoft database, and the execution of the DSP install file. A new DB that is created reads these default settings from the Model database, so it avoids incorrect DB settings.

TempDB Optimization

Configure the TempDB system database to these settings, preferably on SSD:

Go to SQL Databases > System Databases > Tempdb > Properties > Files

  • 8 Files - Each sized at 8GB (8192 MB), 512 MB Growth
  • Log File set to 512 MB, 512 MB Growth

Other SQL Server settings

NOTE: Consult with the Database Administrator for further details.

Go to Programs > SQL Server Configuration Manager > SQL Server Services > right click on SQL Server service > Properties > Startup Parameters > input “-T174” in Specify Startup Parameter > Apply (for each trace flag to add)

  1. Add Trace Flag -T174.
  2. Set all User Databases to AUTOGROW_ALL_FILES (Only for SQL 2016 +).
  3. Set up Weekly Index Maintenance Job.
  4. Set up Weekly Statistics Rebuild Job (or more often as required).
  5. Set up Nightly Database Backup Job.

Create an Empty CranSoft Database

To create an empty CranSoft database:

  1. Open SQL Server Management Studio.
  2. Expand the tree until the SQL Server instance to which CranSoft connects is visible.
  3. Right-click Databases folder
  4. Select New Database from the menu.
  5. Enter CranSoft in the Name field.
  6. Configure non-default data and log file locations, if applicable.

    NOTE: Refer to the Syniti Solutions Software Requirements and Hardware Sizing Guide for recommendations on disk structure and file locations.

  7. Click the OK button to create the database.

NOTE: Other databases required to support the Syniti Solutions are created automatically during the installation process and must not be created manually.

Configure Rights for the Syniti Solutions Login

To add a user to CranSoft database:

  1. Open SQL Server Management Studio.
  2. Connect to the database server.
  3. Expand the Logins branch of the Security folder.
  4. Select the SQL Server login created for the Syniti Solutions in the Configure SQL Server section.
  5. Right-click the Login.
  6. Click Properties.
  7. Click User Mapping in the vertical menu.
  8. Click the CranSoft check box under the Users mapped to this login panel.
  9. Click the db_owner check box under the Database role membership for panel.
  10. Click Server Roles in the vertical menu.
  11. Click the db_creator check box under the Server Roles panel.
  12. Click OK.

Grant Database Server Permissions to Permit Dashboard Functionality in System Administration

To grant database server permissions:

  1. In SSMS, right click on Server name > 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 Alter trace, and then click the Grant checkbox.

  5. Scroll to View server state and click the Grant checkbox.

Before Proceeding with the Syniti Solutions Installation

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

Open the Gather Required Information PDF to prepare responses to the install prompts.

If you have Adobe Acrobat installed, you can complete the form fields, save and print this form.

By default, PDF files open in a browser window. You are unable to save the form when using a browser. Refer to How do I open a PDF instead of the browser? for more information.

Install Package Manager and Syniti Solutions

The Syniti Solutions requires a two-part installation process. First, the Package Manager console is installed from a setup.exe. Second, application packages are installed from within the Package Manager console. When the application packages are installed, the web site properties, folder permissions, database connectivity and initial Syniti Solutions service are configured automatically, based on information supplied at install time. After the Package Manager installation is complete, the process of installing the Syniti Solutions will commence automatically.

NOTE: Ensure .NET 4.8 is installed prior to installing the Syniti Solutions. This install may require a system restart.

To install the Package Manager console and initiate the Syniti Solutions installation.

  1. Locate the SST<Version>FullPackage.exe file downloaded from the zip file provided by Syniti.
  2. Copy the SST<Version>FullPackage.exe file to the Web Server.
  3. Right-click the SST<Version>FullPackage.exe file, select Properties and click the Unblock button, if present.
  4. Right-click the SST<Version>FullPackage.exe file and select Run as Administrator.
  5. Click the Options button to select a folder path for installation. If a path is not specified, Package Manager will be installed to: C:\Program Files (x86) in a \BOA\ sub-directory created by the installer.

    NOTE: Do not choose a path that contains more characters than the default path; otherwise, there is the risk of installation packages failing to unzip correctly. It is recommended to choose an installation folder that is either the default location or the root directory of a local drive, for example, C:\ or D:\. The subfolders \BOA\DSP\ will always be created and this step is not configurable.

  6. Click the Install button.

    NOTE: The Package Manager Console window will open automatically and the Syniti Solutions package installation will commence.

  7. Click Close button on the Setup window in the background when the Setup Successful dialog displays.

  8. Wait while package files are expanded and you are prompted to proceed. This may take several minutes—do not close the console window.
  9. At Parent Web Site prompt, type: Default Web Site.
  10. Press the Enter key.
  11. At Application Name prompt, type the desired virtual directory/application name for the Syniti Solutions installation. Refer to the Before Proceeding with the Stewardship Tier Installation section for detailed information.
  12. Press the Enter key.
  13. At Application Pool Name prompt, type the desired IIS application pool name. Refer to the Before Proceeding with the Stewardship Tier Installation section for an explanation.
  14. Press the Enter key.
  15. At Server Address prompt, type the SQL Server name, including instance name if applicable, or IP address. Refer to the Before Proceeding with the Stewardship Tier Installation section for an explanation and examples.
  16. At Database Name prompt, type CranSoft.
  17. Press the Enter key.
  18. At the User Name prompt, type the SQL Server login name identified for this instance.
  19. At the Password prompt, type the matching password for the SQL Server login specified in the Before Proceeding with the Stewardship Tier Installation section.

    NOTE: If the connection information is mistyped or incorrect, a prompt displays to re-enter it.

  20. At the Password for the Syniti Solutions Administrator user prompt, type the Syniti Solutions Password specified in the Before Proceeding with the Stewardship Tier Installation.
  21. At the Repeat Password for the Administrator user prompt, type the Syniti Solutions Password specified in Before Proceeding with the Stewardship Tier Installation.

    NOTE: If the passwords do not match, you will be prompted to enter the password again.

  22. Wait while database contents are loaded and objects created.
  23. At the Service Name prompt, enter the suffix entered in the Before Proceeding with the Stewardship Tier Installation section that will identify the Syniti Solutions Service.
  24. Press the Enter key.

Wait while the installation continues. This may take 30 minutes or more. Do not close the Package Manager Console until the installation is complete and the Syniti DR InstallShield Wizard is displayed. If any errors display, contact Syniti Support and open a support issue indicating the exact error message.

When prompted by the Syniti Data Replication InstallShield Wizard, follow the steps in the following section.

Install Syniti Data Replication for the Syniti Solutions

Syniti Data Replication for Syniti Solutions provides two packages for data replication from Microsoft SQL Server, Oracle, IBM Db2 LUW (or other ODBC-enabled databases) to Microsoft SQL Server:

  • Complete data replication (Refresh), followed by regular data updates (Mirroring) of changed data only. This process is valuable in situations where the size of tables does not permit a complete data replication within the allotted time frame.
  • Complete data replication (Refresh) using Syniti Data Replication technology. Depending on the environment, this can offer an alternative, more effective, approach to complete data replication.

This section describes how to set up the Syniti Solutions environment to make use of the Syniti Data Replication packages.

Syniti Data Replication for the Syniti Solutions must be installed on the same server. When the Syniti Solutions installation finishes, the 64-bit DBMoto setup file is executed.

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

  1. In the Syniti DR InstallShield Wizard, select the language and click Next.
  2. Accept the license agreement and click Next.
  3. Select the Destination Folder and click Next.
  4. Click the Standard Installation option in the Setup Type window and click Next.
  5. Click Import in the Customer Information and Setup Options window.
  6. Supply the path to the license and click Next.

    NOTE: The Syniti Data Replication for the Syniti Solutions license is included in the installation files and may be found at the following location: C:\Program Files (x86)\BOA\DSP\Packaging\Packages\DSP.SynitiDR-7.4.3+39\SynitiDR\SynitiDR_License_Syniti SST_040821.txt

  7. Check Enable digital signing verification and click Next.
  8. Click Next on the Start Copying Files window.

Continue with all defaults until you reach the Service Dependencies selection.

NOTE: Use the Syniti Data Replication Service Dependencies window to specify services needed by Syniti Data Replication prior to the Syniti Data Replication Agent startup. 

  • If the metadata database (see below) is not local (on the same system where Syniti Data Replication is installed), dependencies do not need to be set. Click Finish to close the window.
  • If the database that is storing the Syniti Data Replication metadata is local (installed on the same system as Syniti Data Replication), the database must be running before Syniti Data Replication to avoid errors when Syniti Data Replication checks the metadata.

NOTE: To add a dependency, select the service in the list, then click Add. The Synti Data Replication Agent will not start until the selected service has started. For example, if the SQL Server service is selected and Add is clicked, SQL Server is added as a dependency; the Syniti service does not start until the SQL Server service starts.

9. Click Install

At the end of the installation, the Syniti Data Replication Service Monitor program is available in the Windows Notification area (System Tray.) Use this program to start the Replication Agent after creating metadata tables in the Syniti Data Replication Management Center (see below).

  1. Click Finish; the Syniti Data Replication Management Center displays.

    NOTE: The following steps remove the default Syniti Data Replication metadata and add a specialized Syniti Data Replication for Syniti Solutions metadata so that connections and replications can be set up automatically from the Syniti Solutions.

Next, in the Metadata Explorer:

  1. Expand the tree, right-click Metadata.
  2. Select Remove Metadata. A confirmation message displays.
  3. Check the Drop the metadata tables from the database check box and click Yes.
  4. Right-click the entry local, and then select Add New Metadata; the Metadata Connection Wizard window displays.
  5. Click Next.
  6. Enter DBMoto_Client in Name field.
  7. Select Microsoft SQL Server from Database list box.

    NOTE: Ensure you select Microsoft SQL Server and do not select Microsoft SQL Server CE.

  8. Click Next to display the connection parameters.
  9. Enter the IP address or server name for the installation of SQL Server, which is running the Collect database (a component of the Syniti Solutions) in Data Source field.
  10. Enter the username that the Syniti Solutions uses in SQL Server (for example, CranSoft) in User ID field.
  11. Enter the password for that database user in the Password field.
  12. Click Test to verify the connection settings.
  13. Click OK to close the message.
  14. Click Next.
  15. Select DBMoto_Client from Database Name list box.
  16. Select dbo from Owner Name list box.
  17. Click Next to set the metadata.
  18. Click Create a new metadata database option.
  19. Click Next.
  20. Click Yes on the pop-up message.
  21. Click Next.
  22. Click Finish.
  23. Exit the Management Center.

Next, in the Syniti Solutions installation directory:

  1. Go to the Database\Apps\DataGarage\Components\
    Objects\PostInstallSteps subdirectory. Right-click the file DBmoto_in_DataGarage_reference.sql and select Open to execute the contents of the file in the DataGarage database in the SQL Server Management Studio.
  2. In the Syniti Solutions installation directory, under the Web\UserArea\4f3346ca-235a-46bd-84d8-1d234b873a0c\Processes folder, locate and open the DBMoto_Global_Script.txt file. Select all text (Ctrl+A) and copy the text (Ctrl+C). Close the DBMoto_Global_Script.txt file.
  3. Open the DBMoto Management Center, right-click the new metadata DBMoto_Client, and select Global Script.
  4. Select VB from the Language drop-down in the Global Script window; a warning message displays.
  5. Click Yes.
  6. Select all (Ctrl+A) and delete the text in the Global Script window.
  7. Copy (Ctrl + C) and paste (Ctrl + V) the text from the DBMoto_Global_Script.txt file into the Global Script window.
  8. Click the Compile Test button in the bottom left corner and click OK in the Compile Test Successful window.
  9. Click OK to close the Global Script window.
  10. Exit the DBMoto Management Center.
  11. In Windows, go to Start > Administrative Tools > Internet Information Services (IIS) Manager.

    NOTE: There are two types of IIS Managers:

    • Internet Information Services (IIS)
    • Internet Information Services (IIS) 6.0 Manager

    Go to Internet Information Services (IIS), NOT Internet Information Services (IIS) 6.0 Manager.

  12. Expand the tree to the left and find the application pool under Application Pools.

NOTE: Select the application pool name chosen in the Install Package Manager and Stewardship Tier section

  1. Right-click the application pool and select Advanced Settings.
  2. Change the Identity field to LocalSystem, and then click OK.
  3. Click OK, and then close the manager.

Post Installation Steps

The following post installation steps must be completed for the Syniti Solutions to be fully functional.

  1. Create a dedicated Data Services Repository for each installation of the Syniti Solutions that uses Data Services, and create a repository in SAP Business Objects Data Services. This must be a dedicated repository to which no other site connects.

    NOTE: For detailed instructions on how to create a Data Services Repository, see the online help topic Set up a Data Services (DS) Repository.

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

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

This section contains the following topics:

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.

Start the Syniti Solutions Service

The final step of the installation process is to start the Syniti Solutions service created in Install Package Manager and Stewardship Tier section.

To access the Package Manager Console to start the Syniti Solutions service:

  1. Click the Start menu, then locate the Cransoft folder.

  2. Right-click the Cransoft folder and select More > Show File Location.

  3. Right-click the CranSoft Package Manager Console file and select Run as administrator.

  4. Type: net start “CranSoft Service suffix.”

    NOTE: Where suffix is the service name suffix entered in the Before Proceeding with the Stewardship Tier Installation section. Valid examples include:

    • net start “CranSoft Service CS1”
    • net start “CranSoft Service DSP”
  5. Press the Enter key.

NOTE: The Services console under Start Menu > Administrative Tools can also be used to start the service.

Log In to the Syniti Solutions Site for the First Time and Configure Licensing

Once the database connection settings have been provided and the database updated, log in to the site to upload a license file.

To upload a license:

  1. Navigate to the Syniti Solutions site at http://MACHINENAME/ApplicationName, using a supported web browser (listed in the Configure Web Browser section), and log in to Syniti Solutions using the login ID, administrator, and password created in the Before Proceeding with the Stewardship Tier Installation section of this document.
  2. The License page opens. Until a valid license has been provided, the Syniti Solutionssite will not be usable.

    NOTE: If you do not have a valid license, follow the steps described in the Obtain License section. Within two business days, Syniti Licensing will send you an email with a license file as an attachment.

    NOTE: Because licenses are tied to a hardware ID, any hardware change can invalidate your current license. If this occurs, Syniti Solutions will display the warning below and you will have 14 days to contact the Syniti licensing team to obtain a new license before the Syniti Solutions will no longer be accessible. If you have purchased a Syniti Knowledge Platform subscription and have configured connections between the Syniti Solutions and the Knowledge Tier, they may also be affected by a hardware change. Contact Syniti Support at https://support.syniti.com when planning updates to hardware.

  3. Click OK for the popup message regarding licensing.
  4. Click the File Upload icon next to <Upload a New Product License…>.
  5. Navigate to the location of the license file received via email.
  6. Select the license file and click Open; a message displays indicating that licenses were installed successfully.
  7. Click OK to close message popup.
  8. Select the Syniti logo to return to the site home page.
  9. Click Save.

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, all licensed components display.

Update Syniti Solutions Parameters

There are numerous parameters available for the Syniti Solutions. For the scope of installation, only a few are required to be populated.

To update the Syniti Solutions parameters in the Syniti Solutions:

  1. Select Admin > Configuration > Parameters in Navigation pane.
  2. Click the Site Parameters tab.
  3. Click Edit.
  4. Enter the URL of the server home directory in Web Site Root field, for example, http://webserver.boaweb.com/SST.

  5. Enter an SMTP server name in Email Server field and a Default Email Address, if applicable.

    NOTE: Complete the Email Server field if workflow emails are to be used within this Syniti Solutions instance.

    NOTE: Refer to the article How to Configure Office 365 as the Mail Server for more information about completing the email server fields.

  1. Click Save.
  2. Select Mass Maintenance > Configuration > Parameters in the Navigation pane and click the Status icon, ensuring it updates to Procedures Completed. This step validates the record and will ensure that the path for the Mass Maintenance Excel files is accurate.

NOTE: Using a fully qualified domain name in the Web Site Root field can eliminate the need to enter Windows Authentication credentials when clicking on a Workflow link.

To update the domain name:

  1. In the Syniti Solutions environment where the workflows originate, (for example, //sampleBox/DSPISA/Virtual.aspx), select Admin > Configuration > Parameters in the Navigation pane.
  2. Enter the fully qualified domain name in the Web Site Root field. For example, replace sampleBox with the fully qualified domain name: sampleBox.rd.syniti.com
  3. Click Save.

NOTE: This change in the Parameters page only affects new workflows created after the update. Any existing workflow messages that have already been sent will still require the user to enter login credentials.

To update the Syniti Solutions Service Queues in the Syniti Solutions:

  1. Select Admin > Configuration > Service > Service Providers in the Navigation pane.
  2. Click Queues icon.
  3. Update the Priority and Maximum Threads fields for each Queue. The table below can be used as a starting point.

    Priority

    Queue ID

    Maximum Threads

    10

    Background Events

    2

    20

    General

    4

    30

    Indexing

    1

    10

    Service Pages

    5

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.

Set Up and Configure File Paths on the Server

There are several components of the Syniti Solutions that require folders to be created on the Web Server and necessary security granted to these folders.  The security access requirements for all folders listed in the table below is the same and requires that the following users have access to read, write, and modify the folders:

  • IUSR
  • IIS_IUSRS
  • LOCAL SERVICE
  • NETWORK SERVICE
  • The user, if not one of the users listed above, configured to run the Application Pool that hosts the Syniti Solutions.
  • The user, if not one of the users listed above, configured to run any CranSoft Service used by the Syniti Solutions.

Create the following folders on the Web server and register the corresponding paths in the proper component of the Syniti Solutions:

Component/

Value

Syniti Solutions Configuration Page Folder Description
Integrate > Import File Location Common > Configuration > Modules > Integrate Import File Location Path where BDC recording file for import are stored
Integrate > Posting Default Folder Common > Configuration > Modules > Integrate Posting Default Folder Default folder for the creation of posting files
Integrate > Post File Archive Folder Common > Configuration > Modules > Integrate Post File Archive Folder Folder to serve as the archive location for posting files
Collect > DataGarage_SSIS_FilePath Admin > Data Sources SSIS File Path Location where SSIS package are stored
Map > cMap_Design_FilePath Admin > Data Sources Design File Path Folder to which all uploaded design documents are stored
Transform > DSW_Documentation_FilePath Admin > Data Sources Documentation File Path Folder to which all documentation uploaded via Transform is stored
Transform > DSW_Export_FilePath Admin > Data Sources Export File Path Folder to store Export files generated by Transform
Transform > DSW_Package_FilePath Admin > Data Sources Package File Path Folder to store Packages generated by Transform
Transform > DSW_Report_FilePath Admin > Data Sources Report File Path Folder to store Report files generated by Transform
Transform > DSW_Source_FilePath Admin > Data Sources Source File Path Folder to store Source files used by Transform
Common > Report Engine FileSystemStore Common > Configuration > Modules > Report Engine > Report Engine > FileSystem Data Stores Report File Path Output of RDIT report files

For example, the three Integrate folders could be created as shown below:

These three Integrate folder locations then need to be registered on the Parameters-Integrate page in Common (Common > Configuration > Modules > Parameters-Integrate).

Performance Note

For large implementations (data downloads of 500 GB or larger) Syniti recommends multiple Syniti Solutions services to split the data downloads and data processing on the Application server.

Please review our support knowledge base article, [DSP/Admin] How to Create an Additional Background Service for DSP, for instructions on how to configure multiple Syniti Solutions services. If additional assistance is required, contact Syniti Support and open a support ticket.

For large implementations, data downloads 500 GB or larger, Syniti recommends multiple Syniti Solutions services to split the data downloads and data processing on the Application server.

Additional Syniti Data Replication Settings

Syniti Data Replication can be used as a standalone product or it can be integrated with the Syniti Solutions. If Syniti Data Replication is integrated with the Syniti Solutions, a few additional settings must be configured.

To configure Syniti Data Replication settings in the Syniti Solutions:

  1. Navigate to Common > Configuration > Modules > Parameters – Collect > SDR Settings tab.
  2. Populate all Syniti Data Replication Settings fields. Refer to the following table for a description of each field:

    Syniti Data Replication Settings

    Description

    Server Name

    Server name defined in the Syniti Data Replication Management Center, from the Metadata Explorer panel under the DBMoto node (for example, local).

    Group Size

    Number of tables in each mirroring group. Groups are used to check system logs for changes. It is more efficient to check once for a group of tables than to log in for each table individually. Group Size must be determined by the client. Each group runs in single thread mode with one table refreshing at a time. The default value is 50.

    Mirror Interval

    For the Mirroring Package type (changed data only), the number of seconds between checking the source database log for changes. As a recommendation, do not use a value less than 60 seconds. The value could be set to 600 so the log can be checked every 10 minutes.  The default value is 900.

    Start Replicator

    If checked, the Syniti Data Replication Agent is started after each Build Package and Refresh Package process. If unchecked, the Syniti Data Replication Agent must be manually started in the Syniti Data Replication Management Center on the application server. This feature is disabled by default.

    Enable Group

    If checked, allows the group to mirror after each Build Package process. If unchecked, the Enable Group must be manually restarted in the Syniti Data Replication Management Center on the application server. The Syniti Data Replication Agent must be running before the data download process can start.  This feature is disabled by default.

    Metric Time

    Controls when all tables without rules will have the boaDBMotoInd set to zero and the daily change count put in the Metrics process. The default value is the date and time that Syniti was installed.

  3. In Collect, add Target and Target Source.
  4. In the Syniti Data Replication Metadata Explorer, add connections for source databases as needed. Note that the source name in Syniti Data Replication must match the target source name in the Collect component of the Syniti Solutions, including case.

  5. In the Metadata Explorer of Syniti Data Replication, add connections for target databases as needed. However, do not enable Transactional Replication for target databases. The target name in Syniti Data Replication must match the target name in the Collect component of the Syniti Solutions, including case.

    NOTE: Refer to the following documents available on https://support.syniti.com for further details on setting up Syniti Data Replication connections:

    Syniti Data Replication Connection Documentation

    Oracle

    Create source connections in the Syniti Data Replication Management Center with names that match the Sources created in the Collect component of the Syniti Solutions.  Refer to the How to Create Syniti Data Replication Source Connections section. Review the Setup Notes for Oracle Transactional Replications in the Help Center for information on required database permissions and settings for Oracle database.

    Microsoft SQL Server

    Create source connections in the Syniti Data Replication Management Center with names that match the Sources created in the Collect component of the Syniti Solutions.  Refer to the How to Create Syniti Data Replication Source Connections section. Review the Setup Notes for Microsoft SQL Server Transactional Replications in the (Help Center) for information on required database permissions and settings for Microsoft SQL Server.

    IBM DB2 LUW

    Create source connections in the Syniti Data Replication Management Center with names that match the Sources created in the Collect component of Syniti Solutions. Refer to the How to Create Syniti Data Replication Source Connections section. Review the Setup Notes for IBM Db2 LUW Transactional Replications in the Help Center for information on required database permissions and settings for IBM DB2 LUW.

    Other databases with ODBC, OLE DB or .NET Provider access

    Contact Syniti Support to submit an issue to verify support for your database. Refer to the How to Create Syniti Data Replication Source Connections section.

  6. Build the DBMoto package in the Collect component of the Syniti Solutions.
    1. Log in to Collect.
    2. Click Targets.
    3. Select the desired target and click the Sources icon.

    1. Click the Table icon for the Target Source.
    2. Verify that the target and source in the Collect component of the Syniti Solutions have the same names as in Syniti Data Replication (case-sensitive).
    3. Click Build Package.

If Syniti Data Replication for the Syniti Solutions was installed correctly and the default settings for the DBMoto package are used, the data replication process runs automatically.  For further assistance with installing and setting up Syniti Data Replication for the Syniti Solutions, submit an issue to Syniti Support.

How to Create Syniti Data Replication Source Connections

Microsoft SQL Server, Oracle, and IBM DB2 LUW are supported as source databases. If using another database, check that the database and version is supported by submitting an issue to Syniti Support.

To create Syniti Data Replication source connections for databases:

  1. In the Metadata Explorer, expand the DBMoto_Client.metadata.
  2. Right-click Sources and select Add New Connection.
  3. In the Source Connection wizard, set values that match the connection specified in the Collect component of the Syniti Solutions on the Target Source (Setup) page. Refer to the documents listed in the Syniti Data Replication Connection Documentation table.
  4. Complete the wizard and check that the connection has been created in the Metadata Explorer.
  5. Create additional connections as needed.
  6. Create Target Connection.

Syniti Data Replication Troubleshooting

If problems arise when building or refreshing DBMotoDownload or DBMotoMirror packages in the Collect component of the Syniti Solutions, verify the following items:

  • The Syniti Data Replication metadata is stored in a SQLServer database, with the following name for the database object: DBMoto_Client.
  • Connection names defined in the Syniti Data Replication metadata (using the Management Center) are the same for the Data Source used in the Collect component of the Syniti Solutions.
  • To use the mirroring package, the transactional log settings are configured in the source connection properties, from the Management Center. The configuration depends on the database type of the connection. Refer to the specific setup guide for privileges and database settings.
  • Syniti Data Replication Agent and Server Agent are installed.
  • Syniti Data Replication Server Agent is running.
  • The identity in the Syniti Solutions Application Pool is Local System.
  • Syniti Solutions service and IIS were reset before trying to use Syniti Data Replication for the Syniti Solutions.
  • The DBMoto setting defined in the Collect component of the Syniti Solutions has the following entry to refer to the dbmoto server: ServerName=<NameOfTheServerDefinedInManagementCenter>.

Installation and Upgrade Supplemental Sections