Stage Information - tsgrp/HPI GitHub Wiki

URL Parameters

When navigating to the Stage in OCMS, parameters can be appended to the URL like so ?key=value&key2=value2&... URL parameters can be utilized to update how the Stage is loaded or to trigger additional functionality/events when navigating to stage. The available URL parameters are listed below.

getCurrentVersion

Example: ?getCurrentVersion=true

When getCurrentVersion is set to true the Stage will load in the current version of the document to ensure the user is viewing/editing the current version of the document. If getCurrentVersion is set to anything other than true it will do nothing.

hideLeftBar

Example: ?hideLeftBar=true

When hideLeftBar is set to true the Stage will load with the left bar collapsed. The left bar can still toggle between open/closed as normal. Currently the collapsing only happens on initial render so that subsequent renders do not toggle the left bar behavior. If hideLeftBar is set to anything other than true it will do nothing.

hideHeader

Example: ?hideHeader=true

When hideHeader is set to true the Stage will load without the navigation header in OCMS. This parameter is useful for when the user is meant to stay on Stage. If hideHeader is set to anything other than true it will do nothing.