Structure Browser - Administration Guide : Page Configurations

1. Page Configuration Objects

A page configuration object acts as a container for common URL parameters that you can use to configure the look and feel of the Structure Browser page, hence this feature supplies an alternative way to configure the Structure Browser. Note that if you use this feature you will still have to configure some parameters on the URL as a page configuration object only supports the common URL parameters described in this section. For instance, you will still have to configure the URL parameter that points to the page configuration object that you intend to use.

${ROOT_DIR}/tvc-action/navigate?pageConfig=My Config

The page configuration object format is described here .

1.1. Custom Parameters

Different use cases with the Structure Browser requires passing additional parameters, these are typically defined within the <Parameters> section of the page configuration instance OR defined as request parameters on the command/HREF that launches the Structure Browser instance.

Example:

<PageConfig>
    ...
    <Parameters>
		<Parameter name="structureGUI" value="caret" />
		<Parameter name="evaluateExpandableNodes" value="true" />
		<Parameter name="persistentExpandState" value="true" />
		<Parameter name="navigationColumn" value="true" />
		<Parameter name="rearrange:column" value="FN" />
		<Parameter name="arrowKeyNavigation" value="true" />
		<Parameter name="portalMode" value="true" />
		<Parameter name="tableRenderer" value="com.technia.tvx.enc.render.EBOMTableRenderer" />
		<Parameter name="drag:enabled" value="true" />
		<Parameter name="drop:enabled" value="true" />
		<Parameter name="sidePanelMaximizeRealEstate" value="true" />
		<Parameter name="connection:type_Part:type_Part"value="relationship_EBOM,from,insert,Preliminary|Review|Create|Peer Review" />
		<Parameter name="connection:type_ECO:type_Part" value="relationship_AffectedItem,to,refreshrow" />
		<Parameter name="connection:type_ECR:type_Part" value="relationship_AffectedItem,to,refreshrow" />
		<Parameter name="connection:type_DOCUMENTS:type_Part" value="relationship_PartSpecification,from,insert" />
		<Parameter name="rearrange:column" value="FN" />
		<Parameter name="rearrange:dropenabled" value="false" />
		<Parameter name="renderTableRowActionsCombined" value="false" />
		<Parameter name="inCellEdit" value="true" />
		<Parameter name="finder" value="true" />
		<Parameter name="finder:openOnLoad" value="false" />
		<Parameter name="expand:selectionMaxLimit" value="5" />
		<Parameter name="entryProcessor" value="com.technia.tvx.enc.hierarchy.KindEntryProcessor" />
	</Parameters>

If you provide a parameter within the request that initiated the Structure Browser instance, such parameter will have precedence over any parameter defined within the page configuration instance.

Example:

${ROOT_DIR}/tvc-action/navigate?pageConfig=tvc:pageconfig/MyPageConfig.xml&structureGUI=default
                                                                          ^^^^^^^^^^^^^^^^^^^^^

1.1.1. Portal Mode

The portalMode can be set to true if we want to remove the headers. It also adds an icon on the toolbar which opens current table in a popup window. It can be defined as below:-

<Parameter name="portalMode" value="true" />

Default is false.

The below images show result when portal mode is enabled and disabled.

Figure 1. portalMode is true

Figure 2. portalMode is false