Parameters Automatically Passed to URLs

When a user chooses a command--such as a menu option or tree category--the system automatically appends one or more parameters to the URL specified in the href parameter for the object.

The target URL can use these parameters if needed or not. The configurable pages and many standard pages use one or more of these parameters and most custom pages will also. For information about which parameters are used by a JSP, refer to the section that describes the JSP.

Parameter Description Values Sent

CurrencyConverter

Passes the value entered for the Currency Converter setting. If True, the target page should include the Currency Converter tool. If the setting is not included, the value is assumed to be false and the target page does not display the Currency Converter tool.

This setting should only be used with Sourcing Central.

Value specified in Currency Converter setting:

True

False

emxSuiteDirectory

The name of the directory for the application under the ematrix directory.

engineeringcentral

HelpMarker

Passes the help marker text specified for the Help Marker setting.

Value specified in Help Marker which is a help marker for the page.

jsTreeID

The ID of the existing tree object, which is required to update the tree with "insert" mode.

When the tree is constructed for the first time, the "jsTreeID" parameter will not have any valid value.

Whenever a category within the tree is clicked, the system passes the current "jsTreeID" to that page and if that page needs to update the tree, it must call emxTree.jsp with the same "jsTreeID" value.

Active NodeId, for example, root_7 or root_7_0_6

objectId

The business object ID for the selected object.

JSPs use the objectId to display information for that object. For example, emxTree.jsp uses it to construct the tree for that object type. If the object is of type "ECR", the tree object of menu type "type_ECR" will be constructed.

Business object ID, for example, 46697.12656.52860.3882

parentOID

Passed to toolbars if there is a valid objectId passed in to emxTable.jsp (in case of tree calling the table page).

Business object ID, for example, 46697.12656.52860.3882

PrinterFriendly

Passes the value specified for the Printer Friendly setting. JSPs that use the PrinterFriendly parameter, such as emxTable.jsp and emxForm.jsp, show the Printer Friendly tool when the setting is True and hide it when False. If the setting is not included, emxTable.jsp and emxForm.jsp show the tool by default. Users can click the tool to get a version of the current page that can be printed with the browser's Print button.

Value specified in Printer Friendly setting:

True

False

relId

The relationship ID for the selected relationship.

JSPs use the relId to display information for that relationship.

 

StringResourceFileId

The name of the String Resource file for the application.

emxFrameworkStringResource

suiteKey

Passes the property name from emxSystem.properties that maps to the Registered Suite setting's value. For example, if the Registered Suite is EngineeringCentral, then the suiteKey value is ServiceSuiteEngineeringCentral.

Name of property in emxSystem.properties that maps to Registered Suite setting value.

TipPage

Passes the value specified for the Tip Page setting. If the setting includes a URL, the target page includes the Tip Page tool and the tool calls the URL when a user clicks it. If the setting is not included, the target page does not display the Tip Page tool.

Value specified in Tip Page setting which is the name of a custom URL page.