Unable to open analysis in Web Player. Error: Spotfire.Dxp.Framework.DocumentModel.ApplyStateException. – Revvity Signals

Date Posted: 2020-09-17
Product: TIBCO Spotfire®

Problem:

Unable to open analysis in Web Player. Error: Spotfire.Dxp.Framework.DocumentModel.ApplyStateException.

Solution:

Description:
Unable to open analysis in Web Player. Error, "Spotfire.Dxp.Framework.DocumentModel.ApplyStateException: An exception occurred during applying document state".

Symptoms:
Unable to open the analysis via the Web Player but can open via the Analyst/Professional client. The following error is reported in the Web Player server logs.

"Spotfire.Dxp.Framework.DocumentModel.ApplyStateException: An exception occurred during applying document state"

Cause:

The problem is caused as there were some changes to the analysis and the user has "Remember personalized view for each Web Player" enabled. The personalized session remembers the filters, marking, active page bookmarks, etc. If any of these are deleted or changed you may see the above exception.

You can force the Web Player not to apply the remembered user's session state by appending '&applyState=false' to the URL used to open the report. This is useful for troubleshooting issues or if a report will not open on the Web Player for particular users.

For example for 7.0 and below, if the URL for accessing the analysis in the Web Player is:

http://mySpotfireServer/SpotfireDxp/ViewAnalysis.aspx?file=Reports/MyReport

append '&applyState=false' and the report will open just as it was saved to the Library:

http://mySpotfireServer/SpotfireDxp/ViewAnalysis.aspx?file=Reports/MyReport&applyState=false

For 7.5 and above the example url,

http://mySpotfireServer/spotfire/wp/analysis?file=Reports/MyReport

append '&applyState=false' and the report will open just as it was saved to the Library:

http://mySpotfireServer/spotfire/wp/analysis?file=Reports/MyReport&applyState=false

NOTE: The manually appending '&applyState=false' to the URL, the behavior has been changed for Spotfire 7.12 and above versions in such situations.

If a document state fails and the analysis can't be opened the error dialog now displays a better error message and the "Reopen analysis" button sets applyState=false which should make the analysis open.

The same has also been fixed in Spotfire 7.11.0 TS HF-006 also documented here TS-55531

https://community.tibco.com/wiki/list-hotfixes-tibco-spotfire-clients-analyst-web-player-consumerbusiness-author-and-automation#toc-5

However, in some situations, some users do not want to lose their personalized state and hence the '&applyState=false' would not be helpful in those scenarios.

In some particular cases, the user may have scripts that change filters into list box filters and simply could not work together with web player state. This is currently not supported by the document state feature and may break.
So in such scenario, they may need to implement the scripts in some other way (either by not changing things into list box filters at all).

KB article https://support.tibco.com/s/article/Tibco-KnowledgeArticle-Article-41634 - How to disable the application of a user's personalized session state when opening analysis in Web Player.

Related articles