Parameters Used by emxHistory.jsp

The emxHistory.jsp page accepts the parameters listed in this table. Additionally, emxHistory.jsp requires the objectId parameter so it knows which object to get history for. The objectId parameter is automatically passed to the page from the tree in the Current Revision mode and from the toolbar item in the All Revisions mode.

Parameter Description Accepted Input Values

Header

The text to use for the header of the History page. This parameter can either be a string resource ID or a mixture of macros and text or simply text.

$<type> $<name> $<revision>

emxFrameworkStringResource.Common.HistoryPageHeading

Object History

HistoryMode

Determines whether the entire revision chain or just the current revision history should be displayed.

AllRevisions--The page displays the entire revision history of the object.

CurrentRevision (default)--The page displays the history for the particular revision that is being reviewed.

For example, a part may have REV A, Rev B and Rev C. If we are reviewing REV B and the HistoryMode is set to "CurrentRevision", only the history for REV B is presented. If HistoryMode is set to "AllRevisions", then the history for REV A, B, C is presented.

preFilter

Determines which action types to display when the History page comes up. If the parameter is not passed, the page lists all action types.

If the Action Type filter control is shown on the page (determined by the ShowFilterAction parameter), the preFilter actions are listed in the text box and the filter is applied to the history list when the page first opens. The user can use the Action Type filter to change the filter, adding and removing displayed actions as needed.

If the Action type filter control is not shown, the user cannot change the preFilter actions. By setting preFilter actions and hiding the Action Type filter, you can hide specific actions that you do not want users to see.

The parameter accepts two types of values:

Comma delimited list of action types:

preFilter=connect, disconnect, create

String Resource ID:

preFilter=emxSystem.preFilter.List

To specify which string resource properties file to look in to get the value, include the SuiteKey parameter. If the SuiteKey is not passed in, the History page looks for the key in the emxSystem.properties file. For example, in the emxSystem.properties file, the value for the emxSystem.preFilter.List might be "connect, create, disconnect".

ShowFilterAction

Determines whether to display the action type filter or not.

true (default)--The action type filter displays.

false--The action type filter does not display.

ShowFilterTextBox

Determines whether to display the filter text box or not.

true (default)--The filter text box displays.

false--The filter text box does not display.

subHeader

Only needed when using All Revisions mode. Determines whether to display Version or Revision for the SubHeader, which separates the history events for each revision.

Version--The History page looks in the emxFrameworkStringResource.properties file for value of the emxFramework.History.Version property.

Revision--The History page looks in the emxFrameworkStringResource.properties file for value of the emxFramework.History.Revision property.

SuiteKey

Determines which string resource property file to look in for the preFilter property key. This parameter is only used when the preFilter parameter is passed in as a resource ID. For example, SuiteKey=eServiceSuiteEngineeringCentral would be required for the preFilter parameter whose value is in the EngineeringCentral properties file, emxEngineeringCentral.properties.

Possible values for the SuiteKey parameter are: eServiceSuiteTeamCentral, eServiceSuiteEngineeringCentral, eServiceSuiteProgramCentral, or any other suite name.