Common JSP for UI views across document types

Any console screen that is an entry point to a particular set of console screens (like the order search or order create screens) may need to include the common JSP used for implementing the user interface view across document type feature. This feature allows existing console screens to be used when viewing information for different document types. This common JSP can be used when the entry point screens in your entity's console require either of the following fields:

Using the common_fields.jsp

The common_fields.jsp (located in the INSTALL_DIR/repository/eardata/smcfs/war/yfsjspcommon directory ) provides many different features for displaying the commonly required fields. The common_fields.jsp should be included in the top of your JSP. JSP parameters should be passed to indicate what features you need for the particular usage of the JSP. For example, if you want to show the node field, then you pass the "ShowNode" parameter as "true."

The following indicates all of the valid parameters that can be passed to the common_fields.jsp.

Parameter Description
ShowDocumentType Indicates whether the document type field should be displayed or not. Default: true.
ShowEnterpriseCode Indicates whether the enterprise code field should be displayed or not. Default: true.
ShowNode Indicates whether the node field should be displayed or not. Default: false.
DocumentTypeBinding Indicates the binding that should be set on the document type field. Default: xml:/Order/@DocumentType.
EnterpriseCodeBinding Indicates the binding that should be set on the enterprise code field. Default value: Xml:/Order/@EnterpriseCode.
NodeBinding Indicates the binding that should be set on the node field. Default value: xml:/Order/@ShipNode.
RefreshOnDocumentType Indicates whether the entire screen should refresh when a document type is selected. Default: false.
RefreshOnEnterpriseCode Indicates whether the entire screen should refresh when an enterprise is selected. Default: false.
RefreshOnNode Indicates whether the entire screen should refresh when a node is selected. Default: false.
ScreenType Indicates the type of screen in which this JSP is being included. This information is used to set the appropriate classes and column layout of the fields inside the JSP. Valid values are "search" and "detail." Default: search.
ColumnLayout Indicates the number of columns used to display the fields. The only valid values allowed are 1 and 3. Default: If ScreenType is "search" then the default column layout is 1. If ScreenType is "detail" then the default column layout is 3.
NodeLabel Indicates what the screen label for the node field should be. Only valid when "ShowNode" is passed as "true." Default: Node.
EnterpriseListForNodeField Indicates if the values that display in the enterprise code field should be based on the selection within the node field. The "RefreshOnNode" parameter should be passed as "true" when this parameter is "true" to ensure that the enterprise list refreshes when a node is selected. Only valid when "ShowNode" and "ShowEnterpriseCode" are "true." Default: false.
Note: Any API called for fetching data for fields within the common_fields.jsp is done by the common JSP itself. There is no need to define resources in your screens for these APIs. For example, if you are showing the enterprise code field using the common JSP, there is no need to define the getOrganizationList() API within your screen's resources.