Upgrade Buddy Server (pre-9.0.0.230)

This applies to upgrading from ENPS versions earlier than 9.0.0.230. See Upgrade from ENPS version 9.0.0.230 or later to upgrade from later versions.

Preparation

Before you start the upgrade process, make sure you do the following checks on the Buddy Server.

Check for G_FIELD Issues

Do this check now only on the Primary Server.

Use the ChangeGFieldID utility to confirm that there is no conflict between your ENPS Fields and System Fields.

  1. Browse to the ENPS Extras section on the ENPS Downloads website.

  2. Download the ChangeGFieldID utility to your Central/Primary server.

    You only need to run the utility on the Central Server, or the Primary Server assuming it is also the site’s Central Server.

  3. Right-click the .zip file and extract the contents.

    See the ChangeGFieldID.docx file in the extracted location for more information about the utility.

  4. Open a Command Prompt.

  5. Drag the extracted ChangeGFieldID.exe file directly into the Command Prompt window.

    This adds the path to the file to the command line. For example, if you extracted the utility to the desktop then the command line should look something like this:

    C:\Users\administrator2\Desktop\ChangeGFieldID\ChangeGFieldID.exe

  6. Append the Central/Primary server disk location and the /I/R switches to the command line.

    For example, if your server location is F:\WDCENPS824-4092, then the command line should now look something like this:

    C:\Users\administrator2\Desktop\ChangeGFieldID\ChangeGFieldID.exe F:\WDCENPS824-4092 /I/R

  7. Press Enter to run the command, which will scan and report conflicts.

Contact Us before continuing if any conflicts are shown in the Command Prompt window. For example:

Continue with the remaining checks on the Buddy Server.

Check for Windows Updates

Check for Windows updates on the Buddy Server, installing and then rebooting the server at a convenient time.

Do not reboot both ENPS servers at the same time.

Update .NET Framework

Ensure that .NET Framework version 4.8 is installed:

  • on the server

  • on all machines that will run the ENPS client

Check the current installed version using the Platform Installer or the registry:

Platform installer

You do not need to close any ENPS processes, just run the Platform Installer. When you get to the following screen it will show you if a required element is missing:

You can then add/fix whatever is missing, then exit out of the installer until you’re ready to install ENPS.

In the screenshot above, the Platform Installer displays the caution triangle indicating that .NET Framework 4.8 is required.

A link to download .NET Framework 4.8 is provided when the caution triangle is clicked.

.NET requires a reboot. Please reboot the Buddy server after .NET is installed, then continue with these steps.

Registry

  1. From the Start menu, choose Run, enter regedit, and then select OK.

  2. In the Registry Editor, open the following subkey: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full. If the Full subkey isn't present, then .NET Framework 4.5 or later is not installed.

  3. Check for a REG_DWORD entry named Release. If it exists, then you have .NET Framework 4.5 or later installed. Its value corresponds to a particular version of .NET Framework.

  4. For .NET Framework 4.8 that value must be 528040 or greater

    .NET Framework version

    Minimum value

    .NET Framework 4.7.2 

    461808 

    .NET Framework 4.8 

    528040 

    .NET Framework 4.8.1 

    533320 

    In the example below .NET Framework 4.7.2 is installed, as the release number is 461814 (Higher than 461808 but lower than 528040).

Check for Unexpected Folders

Check the F:\Common folder for unexpected subfolders.

AUDIT, BUDDY, C_SUPPORT, DBSCRIPTS, ELECTION, G_SUPPORT, and G_SUPPORTBACKUP are expected. Any other folders are should be deleted or moved to the C:\ drive.

Create a Backups Folder

Create a backups folder on your desktop and then copy the following files and folders into the folder:

C:\inetpub\wwwroot
E:\Search Server\data\enps\conf (if applicable - legacy from v8.2.X)
E:\Search Server\SOLRJavaService (where applicable)
F:\Common\G_Support
F:\ENPS
F:\NOM\nom.ini
F:\NOM\AC
F:\NWP
F:\SearchServer
F:\ServerName\S_SUPPORT
F:\ServerName\S_PRIV

The backups folder should now look like this:

Check Data is in XML Format

Confirm that all of your data is in XML format, otherwise data will not appear in searches.

One way to confirm this is by checking whether the oldest archives on your servers are in XML format.

See Convert Data to XML Format for instructions on converting any non-XML files in your data. Content created with ENPS 7 and later is already in XML format, though older archives may not be.

Find AP Media API Key

In this version of ENPS you can ingest your AP Media API wires directly onto your server instead of to a separate box.

To set this up you’ll need to find your AP Media API key:

  1. Log into AP Newsroom.

    Instructions for logging in were sent in a Welcome Letter from the AP. Contact Us if you nor anyone at your site cannot find this letter and cannot find existing login credentials.

  2. Select the option for the AP Media API key in the navigation menu to see the key.

You'll use this key later in the Set Up AP Media API section to set up your AP wires, after you’ve upgraded the server.

Set WebService Version

  1. Open System Maintenance > Services

  2. Remove any number before .svc at the end of the Address URL for the Buddy server webservice.

    For example, change:

    ../nomwebservices3/nomwebservice82.svc

    to

    ../nomwebservices3/nomwebservice.svc.

  3. Set the ServiceVersion for the Buddy server webservice to 9.

    The table should now look something like:

  4. Save changes.

Prepare Search

Purge the index in preparation for a recrawl:

  1. Open a Command Prompt.

  2. Enter the following:

    This command is case-sensitive, and there is a space after .exe before the /

    F:\SearchServer\SearchCrawler.exe /deleteindex:enps

Additionally, change the status of the ENPSDataService, SOLRJavaServer and Windows Search services:

  1. Open Windows Services (services.msc).

  2. Right-click the ENPSDataService service from the list.

  3. Select Stop from the popup menu.

  4. Right-click the SOLRJavaServer service from the list.

  5. Select Stop from the popup menu.

  6. Right-click the Windows Search service in the list.

  7. Select Properties to open a dialog box.

  8. Click Stop.

  9. Set General tab > Startup type to Disabled.

Remove Watch.exe

Remove the Watch.exe shortcut from the startup folders:

  1. Click Start, type Run and enter the following in the Run dialog to open the first startup folder:

    shell:startup

  2. Remove the Watch.exe shortcut from the folder if it exists.

  3. Click Start, type Run and enter the following in the Run dialog to open the second startup folder:

    shell:common startup

  4. Remove the Watch.exe shortcut from the folder if it exists.

Uninstall Java SDK and RTE

Uninstall any versions of Java SDK and RTE in preparation for installing/updating Amazon Corretto:

  1. Open Start Menu > Apps & Features.

  2. Search the apps list for Java SDK.

    Delete any installations found.

  3. Search the apps list for Java RTE.

    Delete any installations found.

Update Corretto for Solr

ENPS requires Amazon Corretto OpenJDK. Ensure you only have Coretto version 11 installed.

First, uninstall any versions of Corretto other than version 11:

  1. Open Start Menu > Apps & Features.

  2. Search the apps list for Corretto.

  3. Click on each Corretto entry to check the version.

  4. Uninstall all Corretto installations that are not version 11.

    If you can't uninstall Corretto because it is still in use:

    1. Open Task Manager.

    2. Open the Services tab.

    3. Right-click SolrJavaService in the list and select Stop from the popup menu.

    4. Try deleting Corretto again.

    If prompted to restart your system:

    1. Remove the Watch.exe shortcut from the startup folders:

      1. Click Start, type Run and enter the following in the Run dialog to open the first startup folder:

        shell:startup

      2. Remove the Watch.exe shortcut from the folder if it exists.

      3. Click Start, type Run and enter the following in the Run dialog to open the second startup folder:

        shell:common startup

      4. Remove the Watch.exe shortcut from the folder if it exists.

    2. Click Yes to restart.

Once all other versions of Corretto have been uninstalled, install Corretto 11 if it is not already installed:

  1. Browse to https://aws.amazon.com/corretto.

  2. Download a Windows x64, .msi Corretto installer for Corretto version 11.

  3. Run the Corretto installer.

  4. Click Next, Next and Install to perform a default installation.

Finally, ensure that SolrJavaService is running:

  1. Open Task Manager.

  2. Open the Services tab.

  3. Ensure that SolrJavaService in the list has a Running status.

    If not, right-click SolrJavaService and select Start from the popup menu.

If the required version of Corretto is not installed, the Platform Installer will also alert you and provide a link to the download site.

For details about using Solr in ENPS, see Solr Search.

Enable Dynamic Compression

The Dynamic Compression feature allows the Internet Information Services (IIS) Webservice to compress data that is being sent to ENPS clients.

Turning on this feature brings a considerable increase in ENPS client performance, particularly for users on a weak connection to ENPS servers. For example, improvements should be noticed with client start time, search time, and general speed when working with rundowns.

To check that dynamic compression is enabled for ENPS desktop clients:

  1. Open Server Manager.

  2. Click Add roles and features.

  3. Click Next in the Add Roles and Features Wizard until you reach the Server Roles page, ensuring your server has been selected:

  4. Ensure that Web Server (IIS) > Web Server > Performance > Dynamic Content Compression is ticked:

  5. Click Next twice and then click Install.

  6. Click Finish when installation has completed.

Installation

Once all Preparation is complete, continue with installation:

  1. Right-click on the ENPS Platform Installer .zip file downloaded in Download Installer and select Properties.

  2. Ensure that the General tab > Unblock box is ticked if it exists, then click OK.

  3. Extract the ENPS installer from the ENPS Platform Installer .zip file.

  4. Run the extracted ENPS Platform Installer.

  5. On the Product Selection screen select the following for a typical ENPS installation:

    • ENPS Server Components - Upgrade

    • ENPS NOM Web Services - Upgrade

    • ENPS Elections API Ingest Service - Upgrade or Install

    Your screen should look like this:

    The installer will flag if the server does not have the correct version of Corretto installed.

    If you see this message, exit the Platform Installer and complete the steps in Update Corretto for Solr above. Then restart the Platform Installer.

  6. On the End User License Agreement screen, read the agreement and accept the terms.

  7. Click Next.

  8. Configure admin login using either:

    Alternatively, do not use auto login on this server.

    This option is not available if the server is already configured to use an admin login method.

  9. Click Next.

  10. On the Configuration > Search Configuration screen, enter a username and password for Solr and ensure that Override and configure SOLR specific settings is ticked.

    Do not leave User Name and Password blank as it may cause later connection issues with Solr.

  11. On the Configuration > IIS Settings screen, Webservice should be preselected with the correct Application Pool (NOMWebServicesAppPool).

  12. Click Next to start installation.

    Click Run in any prompts that appear.

  13. Wait for installation to complete successfully.

  14. Click Install Details.

  15. Click Finish.

  16. Recrawl existing data.

    Recrawling is required due to the removal of the ENPS Data Service and Solr being updated to a new version.

    Recrawling should be deferred until after upgrading:

    1. Ensure that Re-crawling of data required is not ticked.

    2. Click Close.

    3. Perform the manual recrawl when instructed in the After Server Restart section below.

  17. Click OK to close the installer.

    Do not start NOM Watcher.

Proceed to the Post-installation instructions.

Post-installation

Before Server Restart

After Installation is complete and before restarting the server:

  1. Open the backups folders created during Primary Server Preparation.

  2. Open the ENPS\v7\enpsclient.config file.

  3. Compare this file with the same file in F:\ENPS\v7 on the Primary Server, specifically:

    1. Check that the Primary and Secondary webservice settings are correct.

Continue with these steps:

  1. If this server ingests FTP wires, confirm if the FTP wire log files (.DC) are in the NWP folder.

    If not, restore them from the backup of the NWP folder created during Preparation.

  2. Edit the NomWebServiceAppPool application pool:

    1. Open Internet Information Services (IIS) Manager.

    2. In the Connections pane, expand the server name and select Application Pools.

    3. In the Application Pools pane on the right, right-click NomWebServiceAppPool and select Advanced Settings.

    4. Set the Idle Time-out (minutes) option to 0 in the Advanced Settings popup.

    5. Click OK.

    6. Right-click NomWebServiceAppPool again and ensure that it is started.

  3. Delete the contents of the F:\NOM\MOS\OUT folder if it exists.

  4. If your Primary Server is NOT your Central Server, meaning you have a separate Central Server, provided that has been upgraded, then skip this step.

    This step is only necessary if your Primary Server is also your Central Server.

    Copy the following files from F:\Common\G_Support on the Buddy Server to the same place on the Primary/Central server(if it is on an older version):

    G_Fielddef

    G_Langen

Now restart the server.

After Server Restart

After restarting the server:

  1. Launch Watch.exe on the Buddy server.

  2. Open the NOM Buddy Process window on the Primary server and make sure it is emptying out to the Buddy Server.

    If not, try regenerating the schema on the Buddy Server by entering the following in a command prompt:

    F:\SearchServer\SOLRSchemaManager.exe /regenerate /reset:true

  3. Click Start, type Run and enter the following in the Run dialog to open the user startup folder:

    shell:startup

    This should be for the account that is set to auto-logon to start ENPS server.

  4. Copy the Watch shortcut from the desktop to the startup folder.

  5. Confirm that all wires are ingesting as expected.

    If any FTP wires are not ingesting, deactivate the wire, re-enter the password for the FTP server, and activate the wire again.

Set Up AP Media API

Set up your AP Media API wire natively on your server:

  1. Open News Wire Profiler.

  2. Select File > New Wire and select APMEDIAAPIFEEDS from the popup and click OK.

    A new wire window appears.

  3. Click More to expand the window to show settings for the new wire.

  4. Configure the wire as follows:

    Use the API key found in the earlier Find AP Media API Key section.

    Field Description

    Get Member Content

    Not used.

    Server URL

    Set to https://api.ap.org

    API Key

    API credentials provided by AP, for example on AP Newsroom.

    Provider

    Set to AP or other custom setting as needed.

    Although multiple products can be added to each Media API wire, each wire may only have one Provider code. To use multiple Provider codes, create a separate Media API wire for each code.

    Cat Map

    Set to NAA or other custom setting as needed.
    Story Format

    Select MediaAPI_v3.0_Story and MediaAPI_v3.0_Storybody respectively in the two dropdown menus.

  5. Click Click to Refresh to update the Available Products list.

    To add an available product to the Products to Display list, click on the product and then click ADD ->.

  6. Tick the Active checkbox to activate the wire.

  7. If you've previously been ingesting your AP Media API wires on a separate box then that box can now be powered down.

See Wires via AP Media API for more information on this wire.

Set Up Search

  1. Open, f, search server, SearchCrawler.exe.config

    SolrURI path should be <add key="solrUri" value="http://<CURRENTSERVERNAME>:8080/solr/enps" />

    It’s very important that you enter your current server’s name, or change it to local host. Either is fine. If in the example above it was local host it would look like this.

    <add key="solrUri" value="http://localhost:8080/solr/enps" />

    Open, f, search server, SOLRSchemaManager.exe.config, confirm this string.

    <add key="solrUrl" value="http://localhost:8080/solr/enps" />

    In this file, the installer should have put this string in there automatically.

  2. Regenerate the SOLR Schema. There are spaces after .exe and after regenerate

    Run the following from command prompt:

    f:\SearchServer\SOLRSchemaManager.exe /regenerate /reset:true

  3. Copy and paste the searchcrawler.exe.config to the desktop of the server. You want to do this so that once we are done with the next few steps you can put it back easily.

  4. Open SearchCrawler.exe.config , from the search server folder on the root of F.

    Look at the database section. You’ll see entries for NWS, primary server name and buddy server name. See the picture below.

    To speed up the process for the crawls, you’re going to edit those sections so that it looks like this:

    No more NWS , primary server name folder and buddy server name folder. Instead you’re telling it to just check the files, in these specific folders. Just look in the primary server name folder for what groups the station has.

    It's easiest to copy one of the existing strings, and then add to it. So for example, copy:

    <add key=”PRIMARYSERVER” value=F:\PRIMARYSERVERNAME” />

    and change it to:

    <add key=”Group1” value=F:\PRIMARYSERVERNAME\P_group” />

    You will add a line for every p_group the site has that needs to be indexed. This is going to be mainly your news and desk groups. You do not need to crawl your mos folders.

  5. Save the file.

  6. Run the SearchCrawler utility to repair any duplicate GUIDs and remove duplicate stories from WIP data:

    f:\SearchServer\Searchcrawler.exe /repairguids /removeduplicatestories

    As it is scanning the data you will see the following repeated line Solr: 0 files.

  7. When the crawl is done, replace the changed SearchCrawler.exe.config with the backup you put on the desktop.

  8. Run the SearchCrawler utility to recrawl the data:

    f:\SearchServer\Searchcrawler.exe

At this stage the server can be used by users. However, not all data cannot be searched for until the crawl is complete.

When that crawl is done, scan the entire index to check if the H drive has any duplicate stories. To do so:

  1. Open a Command Prompt.

  2. Enter the following:

    f:\SearchServer\Searchcrawler.exe /repairguids /removeduplicatestories

    There is a space between .exe and /repairguids and another space after before /removeuplicatestories

    As it is scanning the data you will see the following repeated line Solr: 0 files.

  3. Wait for the command to complete.

  4. Open the F and H drives and check if there are duplicates folders:

    F:\P_<GroupName>_Duplicates

    H:\P_<GroupName>_Duplicates

    If there are no such folders then skip these steps.

    1. Move any duplicates folders to another location, such as the Desktop.

    2. Run the crawl again:

      f:\SearchServer\Searchcrawler.exe /resume:false

Next Steps

You have now upgraded the Buddy Server!

Proceed to Upgrade Primary Server (pre-9.0.0.230).