URL Parameters Accepted by emxForm.jsp

This table lists the parameters available to emxForm.jsp. You can add these parameters to the href parameter for the component that calls the form. For example, when you specify the emxForm.jsp to be called from a tree category, you can add these parameters to the href parameter for the menu object.

Parameter Description Accepted Input Values

appendFields

The name of the web form that defines fields that you want to include in the form being defined.

  

appendURL

Defines additional parameters to append to the URL string and is specified in this format:

<KEY>|SuiteKey

Where the KEY is a value in the properties file of the specified SuiteKey. See Additional URL Parameters for Forms.

Effectivity|EngineeringCentral

displayCDMFileSummary

Determines if the file summary list should display on the same page as the Properties for a CDM object.

true

false (default)

editLink

Use to have the system include a default Edit toolbar item in the View Form header.

true

false (default)

emxForm.jsp?form+ENCPart&editLink=true

*form

Specifies the web form administrative object used for presenting the form page. You must use the actual form name: symbolic names are not supported.

Name of web form administrative object.

emxForm.jsp?form=ENCPart

formHeader

Use to define the content of the heading that appears at the top of the form page, in the header frame. The value can be either a string resource id or the label itself. The text in the label and string resource ID can contain any valid select expression.

emxForm.jsp?form=ENCPart&formHeader=Properties

emxForm.jsp?form=ENCPart&formHeader=Properties:$<type>$<name>

emxForm.jsp?form=ENCPart&formHeader=emxQuoteCentral.AssignedPackages.AssignedPackages

HelpMarker

Specifies the name of the help marker to call for context-sensitive help. The Help link always displays for form pages.

The naming convention for help markers is the page title, as displayed at the top of the visual page, prefixed with "emxhelp". The marker is all lowercase with no spaces.

jpoAppServerParamList

Allows session data to be passed to a JPO and uses the format:

scope:attributeName

where scope can be one of these values:

application

session

request

and the attribute must be a valid attribute used within the specified scope. The parameter can pass a comma-separated list of scope:attributeName values. The attribute values must be serializable.

application:<attributeName>,session:<attributeName>,request:<attributeName>

launched

Specifies the behavior of the popup page. You can change the behavior of the popup page from the normal mode pages using this parameter.

When the user clicks the Launch button from a channel tab, launched=true is passed to the new popup page which indicates that the popup is a result of clicking the Launch button.

In normal mode, pages will not have the launched parameter and will default to launched=false.

true

false (default)

mode

Specifies whether the form page should be view or edit mode.

view (default)--form is read only

edit--form is editable

emxForm.jsp?form=ENCPart&mode=edit

objectId

Use to specify the business object that the properties need to be displayed for.

Valid business object ID.

emxForm.jsp?objectId=3243.32424.232

portalMode

Every page configured inside the PowerView includes the parameter portalMode=true, so that the page can differentiate between normal display and portal display.

When the Launch button is clicked, it launches the currently displayed channel tab into a maximized popup window, passing the parameters launched=true and portalMode=false to the new window.

true

false (default)

postProcessJPO

Used to specify the post processing JPO program name and the method name to invoke after form processing and database update.

This parameter is applicable only for edit mode.

<JPO Name>:<Method Name>

For example:

emxPart:processECO

postProcessURL

Specifies the name of the JSP executed during edit form post processing. The JSP is executed only after the form processing and database update complete.

This parameter is applicable only for edit mode.

${SUITE_DIR}/emxCustomPostProcess.jsp

<AppDirectory>/emxCustomPostProcess.jsp

For example:

engineeringcentral/emxCustomPostProcess.jsp

preProcessJavaScript

Defines a JavaScript function and is called after the form is loaded in edit mode to execute custom processing. Can be a single function, or a semi-colon separated list of functions.

JavaScript function name

PrinterFriendly

Specifies whether the form page should include the Printer Friendly tool.

true (default)

false

RegisteredDirectory

Specifies the directory where the help files are located.

Directory name within ematrix.

relId

Specifies the relationship used to get the relationship attribute values for relationship fields.

Valid relationship ID.

emxForm.jsp?relId=3243.32424.232

renderPDF

Specifies whether the Render PDF icon displays in the form toolbar in View mode.

If the parameter is not passed in, the default is false and the icon is not shown.

true--The Render PDF icon displays in the form toolbar.

false--The Render PDF icon is not displayed in the form toolbar.

showClipboard

This menu is enabled by default and adds the to the page toolbar. The icon acts as a pull-down menu:

If the user clicks , selected objects are added to the clipboard collection for that user. If the user clicks the arrow, the user can select the New/Add to Collections or Add to Clipboard Collection command.

The showClipboard menu command only shows in the View form; the Edit form does not support the clipboard/collections functionality.

Set the value for this parameter to false to disable this feature.

true (default)

false

showPageURLIcon

When true, shows in the toolbar. This tool lets users copy the URL to the specific ENOVIA application page. When false, does not show in the toolbar.

The default value for this parameter is defined by the emxFramework.Toolbar.ShowPageURLIcon property in emxSystem.properties.

true

false

showTabHeader

Applies only in Portal mode (when the page is displayed within a PowerView), enables or disables the page header.

If false, the header text is not displayed in the PowerView tab.

If true, the header text shows in the tab.

true

false (default)

submitAction

Determines the action to take after completing the form (user clicks Done or other action button other than Cancel, in addition to closing the form window):

refreshCaller: Reload the calling page. If called from a table or structure browser, then reloads the table or structure browser.

doNothing: When called from a table or structure browser, does not refresh (including sorting) the calling page.

treeContent: Load the newly-created object's tree in the main content frame.

treePopup: Load the newly-created object's tree in a new pop-up window.
targetLocation When a URL is defined to open in the slide-in frame (the Target Location setting for the component is set to slidein), BPS appends this URL parameter with this value. This parameter supports a custom page where the html for a popup window needs to be different than the html for a slide-in window. slidein

TipPage

Specifies the Web page (html or jsp) to launch when the user clicks one of the page toolbar buttons in the form header frame.

Name of a custom URL page.

emxForm.jsp?form=ENCPart&TipPage=../myapplication/showMyTipPage.jsp?

toolbar

Specifies the menu administrative object used in the header frame that represents an action or filter toolbar.

The value can be a comma-separated list of menus/toolbars.

PMCWBSTaskToolbar

ECEBOMToolbar,ECEBOMFilter

*Required