TIBCO Scribe® Insight Upgrade Checklist

TIBCO Scribe® Insight Upgrade Checklist

book

Article ID: KB0074474

calendar_today

Updated On:

Products

TIBCO Scribe Insight

Description

When upgrading TIBCO Scribe® Insight there are a number of items to do or validate. This article is a guideline for those items. There is no downgrade script. If you need to go back to an earlier version of Insight after an upgrade, the process is to rebuild from the backups. Make sure you have all the needed backups in place before attempting an upgrade. 

We recommend you test upgrades in a lower, non-production environment before upgrading. That will help you identify any possible version compatibility issues. 

1. Installer Files 

TIBCO Scribe Insight Downloads are located here. Note that Insight 7.9.5 is the only version available for download. If you upgrade from a previous version, there is no downgrade script. You would need to install the old version from your copy of the old version's installer files. Be sure to review all software release notes and this article before upgrading. Release notes are located in the TIBCO Scribe Insight Help Library.

2. Backup
  • Pause Publishers & Integration Processes
  • If upgrading TIBCO Scribe Insight:
    • Backup ScribeInternal Database
    • Make a Copy of the Collaborations folder
    • Check the size/rows of the AlertLog, ExecutionLog, TransactionErrors
If these contain a large number of records, run the ScribeMaintenance.sql found in the folder where Scribe is installed and specify the number of days to keep (e.g. 60)
   Select Count(0) as eLOG From SCRIBE.EXECUTIONLOG;
   Select Count(0) as aLog From SCRIBE.ALERTLOG;
   Select Count(0) as teLog From  SCRIBE.TRANSACTIONERRORS;
   
3.  Serial Number
  • Verify maintenance is current or you will not be able to register after the upgrade (contact Support)
  • Save a copy of the serial number from the Workbench into notepad (Help, About)
  • Unregister TIBCO Scribe Insight from the Workbench (optional)
 
4. Stop the Scribe Windows services
  • Close any Workbench or Console instances
  • From Task Manager - End the Scribe.UpdateService.exe (if it exists)
 
5. Pre-Installation
  • Ensure UAC is disabled (this may require a reboot)
  • For certain adapters Windows Identity Foundation (WIF) is required
    • Windows Server 2008 – Download and Install appropriate version of WIF
    • Windows Server 2012 – Enable/Install WIF 3.5 via Features
  • Windows Features:
    • Enable/Install .NET 3.5 and WIF 3.5 Framework via Features
  • Install Microsoft Message Queuing (MSMQ) if necessary
    • Required if using Query Publishers or the AX, CRM, GP, or NAV Publishers
  • Verify .NET Framework 4.5.2 or later is installed
 
6. Run the installation
  • If upgrading from TIBCO Scribe Insight version 6.4.0 or earlier, manually uninstall TIBCO Scribe Insight and adapters first.
  • If Insight is prior to version 6.4.0, install 6.4 and upgrade the ScribeInternal Database and DTS's.
  • Then upgrade 6.4 to the latest version.
  • Install TIBCO Scribe Insight & the appropriate adapters.
If during the installation the error "previous program installation was not completed" is observed, see the following article for information: https://support.tibco.com/s/article/Scribe-Insight-Setup-Restart-Pending-x
  
7. ScribeInternal Database
  • Existing ScribeInternal Database (SIDB):
    • If the SIDB will stay on the current server choose the option to upgrade the existing SIDB  
  • If an existing SIDB was restored from another TIBCO Scribe Insight instance (assumes Scribe server same is different)
    • Choose to install a new SIDB
    • After the installation is complete - Restore the existing SIDB to SQL Server
If you get Scribe Schema errors after restoring the database, run the SQL statement below. Usually this is only required if using SQL authentication and a Scribe user exists in SQL

ALTER USER Scribe WITH LOGIN = Scribe
  • Run the Update Database option from InternalDB.exe  (if TIBCO Scribe® Insight versions are different)
  • For both scenarios above, verify there are no database validation errors
    Validation occurs during the upgrade process and can also be performed manually by using the Test Database in the InternalDB.exe utility. Contact Support if you see validation errors.
 
** See Additional Considerations below
 
8. Post-Installation
  • If TIBCO Scribe Insight is on a new server the server references in the ScribeInternal Database will be incorrect
Run the InternalDB.exe and perform a Test connection
Then choose the to change the server name
Specify old/new scribe server name
  • Register TIBCO Scribe Insight through the Workbench
  • If you have issues registering Scribe run the ClearScribeLicense.sql found in the folder where TIBCO Scribe® Insight is installed
  • Check the Scribe Windows services LogOn user
It should be a domain account that belongs to the local Administrators and Scribe Console User groups
  • Restart the services    
  • Many of the Adapters have their own post-installation steps - See the Adapter Help file and Release Notes in the TIBCO Scribe Insight Help Library.
Also check the release notes. For example, the NAV release notes will indicate if the FOB files need to be imported (e.g. for minor releases)
  • GP – Metadata SQL Scripts
  • NAV – FOB files and much more
  • AX 2009 - Import xpo files and more
 
9. Test Integrations
  • Open DTS to upgrade the DTS and verify the connections are working
    This may require generating new global connections
 
10. Troubleshooting (typically needed if installing Scribe and/or ScribeInternal DB on a new server)
  • Ensure UAC is disabled (this may require a reboot) – Run repair on TIBCO Scribe Insight via Programs & Features
  • Scribe Services Logon User is a domain account that belongs to the local Administrators & Scribe Console User groups
  • Verify the proper server name are in the various fields for the tables below - If not fix with InternalDB.exe
IntegrationServers, Ksync, Monitors
  • Verify Path is correct in the Ksync table (CollaborationsRoot - KEYVALUE),
  • If using Windows Authentication for ScribeInternal verify the service logon user is db_owner permissions for ScribeInternal DB
  • Run ClearScribeLicense.sql and reregister in the Workbench
11. Additional Considerations

When moving TIBCO Scribe Insight to a new server, some users prefer to create a new database and import the console configuration rather than use or restore the old one. Some things to consider since many of the ScribeInternal tables will be empty:
  • Key cross reference data will not exist
  • The Scribe system variable LastRunDateTime will not exist or be defined
    • For DTS’s the LastRunDateTime is retrieved from the ExecutionLog table
    • For Query Publishers it is retrieved from the Bridges table
  • PubSnapshots table, used by the Query Publisher comparison option, will be empty
  • Any Rejected Row tables will not exist

Issue/Introduction

List of items to do or validate when upgrading TIBCO Scribe® Insight

Additional Information

These articles contain resources that might be helpful as you plan your upgrade project.

This first article describes how to download TIBCO Scribe Insight version 7.9.5 and where the license key can be found. 

https://support.tibco.com/s/article/Downloading-TIBCO-Scribe-Insight-v7-9-5-Using-eDelivery

This second article has the TIBCO Scribe Insight Installation Guide attached to it. 

https://support.tibco.com/s/article/Scribe-Insight-Installation-Guide