Resolving Cobranding Package Versioning Issues

Resolving Cobranding Package Versioning Issues

book

Article ID: KB0070083

calendar_today

Updated On:

Products Versions
Spotfire Analyst All

Description

After deploying a new cobranding package, the client application may still display the old branding package, even though the new package was successfully deployed and the old package was removed. This behavior is often caused by a package versioning issue.

Symptoms
Typical symptoms of a package versioning issue include:

- The client application continues to display the old cobranding package, despite a successful deployment of a new package.
- No errors are reported during deployment, and the old package has been removed.
- Logs may show that no new modules were found when the client checks for updates.


Sample log entries that might indicate this issue:

2024-06-28T15:16:56,725-04:00 2024-06-28 19:16:56,725 username [Main Thread] DEBUG Spotfire.Dxp.Loader.Program [(null)] - User has not chosen remember deployment area. User chose 'CoBranding'.
2024-06-28T15:16:56,725-04:00 2024-06-28 19:16:56,725 username [Main Thread] DEBUG Spotfire.Dxp.Loader.Program [(null)] - Setting area 'cobranding' as area in connection status and in rememberArea state information.
2024-06-28T15:16:56,725-04:00 2024-06-28 19:16:56,725 username [Main Thread] INFO  Spotfire.Dxp.Framework.ModuleHandling.ServerModules [(null)] - Initiating server modules from 'https://your-deployment-server.com/' with client=Forms, platform=WINDOWS_X64 and framework=NETFRAMEWORK
2024-06-28T15:16:56,725-04:00 2024-06-28 19:16:56,725 username [Main Thread] DEBUG Spotfire.Dxp.Services.Http.SpotfireRequest [(null)] - Creating request to 'https://your-deployment-server.com/spotfire/deploy/CoBranding/Contents/manifest.xml'.
2024-06-28T15:16:56,818-04:00 2024-06-28 19:16:56,818 username [Main Thread] DEBUG Spotfire.Dxp.Loader.Program [(null)] - Found 0 new modules
 

Explanation of the Logs
These log entries help diagnose the issue:
1. Module Initialization

INFO Spotfire.Dxp.Framework.ModuleHandling.ServerModules [(null)] - Initiating server modules from 'https://your-deployment-server.com/' with client=Forms, platform=WINDOWS_X64 and framework=NETFRAMEWORK
  This log shows the client starting module initialization from the specified deployment server, using the provided client type, platform, and framework.


2. Request to Manifest File

DEBUG Spotfire.Dxp.Services.Http.SpotfireRequest [(null)] - Creating request to 'https://your-deployment-server.com/spotfire/deploy/CoBranding/Contents/manifest.xml'.
  This entry indicates that the client is attempting to retrieve the manifest "CoBranding" .spk file (the cobranding package), which includes metadata about the modules and their versions.


3. No New Modules Found

DEBUG Spotfire.Dxp.Loader.Program [(null)] - Found 0 new modules
  The client did not find any new modules to download or update, suggesting it believes it already has the latest version, which may indicate a versioning conflict.

Cause

The issue is likely due to a package versioning problem. The client application uses the package version, set in the package metadata (such as 'module.xml'), to determine if a new package should be downloaded. If the version number is not updated correctly during deployment, the client may not recognize the new package and continue using the old one.
 

Issue/Introduction

This guide provides steps to troubleshoot a cobranding package that does not reflect after being successfully deployed in Spotfire.

Environment

All

Resolution

1. Check the version number specified in the package builder. Ensure it matches the intended new version.
2. Compare the modules installed or downloaded on the client with the contents of the manifest file on the deployment server. Verify that the version numbers align with the newly deployed package.
3. Make sure the version number in the package metadata file (e.g., 'module.xml') is correctly incremented. This change will prompt the client to recognize and download the new package.
4. After updating the version number in the metadata, redeploy the package to the deployment area.