skip to main content
Maps > Programmer's documentation > Building Web Applications > JViews Web applications client/server exchange protocols and securities > JViews Web application client/server exchange protocols
 
JViews Web application client/server exchange protocols
Describes the different types of JViews requests and provides detailed information on their parameters.
*JViews requests
*Lists client request parameters and provides example URLs.
*Common requests
*Describes common requests available in all JViews Web components
*Available requests for JViews Diagrammer, JViews Maps and JViews TGO
*Describes requests available in all JViews Diagrammer, JViews Maps and JViews Telecom Graph Objects Web components.
JViews requests
JViews Web technologies provide the necessary client/server infrastructure to display your JViews product data on a Web browser. Information exchange with request parameters is performed on the client side and mapped to the servlet which responds, if appropriate, with an image update.
This section contains a list of all client request parameters together with their expected values that are available in JViews Web applications. For each request, the specific servlet/servlet support class required to respond is also provided and an example URL to further explain the exchange protocols. The list starts with common requests that you can use in all JViews Web components, then presents product specific requests and finally introduces special requests available in JViews Google Maps™ Web components.
Common requests
There are four common requests which are used for all JViews components:
*pop-up menu : to display a static or contextual pop-up menu when the application user right-clicks in the view.
*resource loading : to load resources (.gif, .jpg, .js, .jpeg,.css,.png) from the client.
*script message loading : to loadJavaScript messages.
*selection : to select objects in the view.
The following sections provide tables of possible parameters with their expected values for each common request. If a parameter must exist in a request, this is indicated by a value true in the Required column. The Expected value column gives predefined options in JViews components. When security checking is enabled, these expected values are compared with the values sent by the user request. A true value in the Compared by default column indicates that the comparison is performed by default.
Pop-up menu
The pop-up menu request displays a static or contextual pop-up menu when the application user right-clicks in the view and is supported by the class IlvManagerPopupServletSupport and IlvFacesDiagrammerPopupSupport.
Example URL: http://hostname:port/your_Webapp_context/_contr?request=popupmenurequested&format=html&point=(229,121)&menufactory=%23%7BframeworkBean.menuFactory%7D&layer=0&params=(213.82680355539304,198.05370099408609,-166.24449927225749,-2.7700005,829.8500061739095,497.9100037043457,500,300,%23%7BsessionScope.ILOG_j_id_jsp_613493658_16_finder%7D)&facesData=ilog.views.faces.dhtml.servlet.IlvFacesManagerServlet&facesService=forward&facesComponentId=view&componentWidth=500&componentHeight=300
 
Name
Required
Expected value
Compared by default
Compare method
Description
componentHeight
false
0
false
 
The desired height in pixels of the component.
componentWidth
false
0
false
 
The desired width in pixels of the component.
context
false
0
false
 
The binding to a JViews TGO context bean.
facesComponentId
false
0
false
 
The ID of this component used in a JSF environment.
facesData
false
0
false
 
The ID of this component used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by the control servlet used in a JSF environment.
format
true
html
true
EQUALS
The servlet response to the request is in HTML format.
imapGenerator
false
0
false
 
The image map generator which will be invoked to create the image map dynamically.
jviewsPageId
false
0
false
 
Page identification from the request worked for multitab pages.
layer
false
0
false
 
Comma-separated list of names of the visible layers.
locale
false
0
false0
 
The expected locale sent by client
menufactory
false
0
false
 
The factory that will dynamically generate the pop-up menu depending on the graphic object clicked.
modelId
false
0
false
 
The menu model ID. This property is used when this interactor is set on a view and when this view is using a dynamic contextual menu. The generation of the contextual menu might depend on this ID.
namespace
false
0
false
 
The portlet namespace.
objectActionMB
false
0
false
 
Method binding key to a method that will process a click in the view (only used in JViews TGO)
params
true
0
false
 
The action parameters.
point
true
0
false
 
The x,y coordinate of the clicked point on the image coordinate system.
request
true
0
false
 
The JViews Web request will be handled by server side.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
Resource loading
The request to load resources (. gif, .jpg, .js, .jpeg, .css, .png ) from the client is supported by the servlet class of IlvResourceController
Example URL: http://hostname:port/your_webapp_context/_contr?facesService=forward&facesData=res&type=text/javascript&v=8.8.0.0&res=$res$/core.js
 
Name
Required
Expected value
Compared by default
Compare method
Description
facesData
true
res
true
EQUALS
The servlet class of IlvResourceController used for loading resources.
facesService
true
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
jviewsPageId
false
0
false
 
Page identification from the request (when the multi-tab page feature is enabled).
locale
false
0
false
 
The expected locale sent by the client.
module
false
0
false
 
The access module of existing resources.
namespace
false
0
false
 
The portlet namespace.
res
true
gif; jpg; jpeg;.png;.js;.css
true
END_WITH
Only resources with the following suffixes can be loaded: .gif;.jpg;.jpeg;.png;.js;.css.
res
true
/. ; ./ ; .. ; : ; /WEB-INF
true
NOT_CONTAINS
The URL for accessing the resources cannot contain the pattern /. ; ./ ; .. ; : ;/WEB-INF.
type
false
text/javascript
true
LIST
The type of resources to be loaded.
v
false
0
false
 
JViews product version information.
Script message loading
The request to load JavaScript messages is supported by the servlet class of IlvScriptMessageServletSupport
Example URL: http://hostname:port/your_webapp_context/_contr?facesService=forward&facesData=res&v=8.8.0.0&res=$res$/&request=scriptMessage&module=/data/script-messages.js
 
Name
Required
Expected value
Compared by default
Compare method
Description
facesData
true
res
true
EQUALS
The servlet class of IlvResourceController used for loading resources.
facesService
true
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
locale
false
 
false
 
The expected locale sent by the client.
module
true
 
false
 
The access module of existing resources.
request
true
 
false
 
The JViews Web request will be handled on the server side.
res
false
 
false
 
The script message to be loaded.
v
false
 
false
 
JViews product version information.
Selection
There are many types of selection that are supported by JViews Web components. For example, selectOne, selectAll, selectMulti are supported by the classes IlvFacesDiagrammerSelectionSupport and IlvDiagrammerSelectionSupport.
You can find in the following sections descriptions on all types of selection supported by JViews with their expected parameters and values.
selectOne
SelectOne selects the graphic object in the view at a given position.
Example URL: http://hostname:port/your_webapp_context/_contr?request=lightselect&bbox=-6.5585938%2C-855.31415752%2C2958.2533938%2C2366.60271504&width=500&height=400&layer=Links,Nodes&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&componentWidth=500&componentHeight=400&infoProviderMB=%23%7BgalleryBean.propertyAccessor%7D&selectionType=selectOne&x=147&y=178&mouseUp=true
 
Name
Required
Expected value
Compared by default
Compare method
Description
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
comp
false
chart; table; sheet
false
LIST
The component type requested by the client.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
height
true
 
false
 
The desired height, in pixels, of the component.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
imapGenerator
false
 
false
 
The image map generator which will be invoked to create the image map dynamically.
infoProviderMB
false
 
false
 
Method binding key to a method that accesses selection property.
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
mouseUp
true
true; false
true
LIST
Determines whether it is mouse up.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
request
true
 
false
 
The JViews Web request will be handled by server side.
selectionType
true
 
false
 
The type of selection.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
vpos
false
 
false
 
The vertical scroll position used in JViews Gantt.
width
true
 
false
 
The desired width, in pixels, of the component.
x
true
 
false
 
The x-coordinate of the clicked point in the image coordinate system.
y
true
 
false
 
The y-coordinate of the clicked point in the image coordinate system.
selectMulti
SelectMulti selects the graphic object, if any, found at a given position.The response updates the client-side selection accordingly. If a selectable object is found at the specified position, it is added to or removed from the selection: an already selected object is deselected; an object that is not already selected is selected. Otherwise (if there is no selectable object), the selection is unaltered.
Example URL: http://hostname:port/your_webapp_context/_contr?request=lightselect&bbox=-6.5585938%2C-855.31415752%2C2958.2533938%2C2366.60271504&width=500&height=400&layer=Links,Nodes&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&componentWidth=500&componentHeight=400&infoProviderMB=%23%7BgalleryBean.propertyAccessor%7D&selectionType=selectMulti&x=147&y=197
 
Name
Required
Expected value
Compared by default
Compare method
Description
bbox
false
0
false
 
The rectangle that contains all the graphic objects.
comp
false
chart; table; sheet
false
LIST
The component type requested by the client.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
height
true
 
false
 
The desired height, in pixels, of the component.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
imapGenerator
false
 
false
 
The image map generator which will be invoked to create the image map dynamically.
infoProviderMB
false
 
false
 
Method binding key to a method that accesses selection property.
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
selectionType
true
 
false
 
The type of selection.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
vpos
false
 
false
 
The vertical scroll position used in JViews Gantt.
width
true
 
false
 
The desired width, in pixels, of the component.
x
true
 
false
 
The x-coordinate of the clicked point in the image coordinate system.
y
true
 
false
 
The y-coordinate of the clicked point in the image coordinate system.
selectAll
SelectAll selects all the graphic objects in the view.
Example URL: http://hostname:port/your_webapp_context/_contr?request=lightselect&bbox=-6.5585938%2C-855.31415752%2C2958.2533938%2C2366.60271504&width=500&height=400&layer=Links,Nodes&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&componentWidth=500&componentHeight=400&infoProviderMB=%23%7BgalleryBean.propertyAccessor%7D&selectionType=selectAll
 
Name
Required
Expected value
Compared by default
Compare method
Description
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
height
true
 
false
 
The desired height, in pixels, of the component.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
imapGenerator
false
 
false
 
The image map generator which will be invoked to create the image map dynamically.
infoProviderMB
false
 
false
 
Method binding key to a method that accesses selection property.
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
request
true
 
false
 
The JViews Web request will be handled by server side.
selectionType
true
 
false
 
The type of selection.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
width
true
 
false
 
The desired width, in pixels, of the component.
deSelectAll
deSelectAll deselects all the graphic objects in the view.
Example URL: http://hostname:port/your_webapp_context/_contr?request=lightselect&bbox=-6.5585938%2C-855.31415752%2C2958.2533938%2C2366.60271504&width=500&height=400&layer=Links,Nodes&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&componentWidth=500&componentHeight=400&infoProviderMB=%23%7BgalleryBean.propertyAccessor%7D&selectionType=deselectAll
 
Name
Required
Expected value
Compared by default
Compare method
Description
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
height
true
 
false
 
The desired height, in pixels, of the component.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
imapGenerator
false
 
false
 
The image map generator which will be invoked to create the image map dynamically.
infoProviderMB
false
 
false
 
Method binding key to a method that accesses selection property.
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
request
true
 
false
 
The JViews Web request will be handled by server side.
selectionType
true
 
false
 
The type of selection.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
width
true
 
false
 
The desired width, in pixels, of the component.
UpdateAll
UpdateAll resynchronizes the selection state between the client and the server.
Example URL: http://hostname:port/your_webapp_context/_contr?request=lightselect&bbox=-6.5585938%2C-855.3141540727343%2C2958.25341801875%2C2366.6027344149998&width=500&height=400&layer=Links,Nodes&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&componentWidth=500&componentHeight=400&infoProviderMB=%23%7BgalleryBean.propertyAccessor%7D&selectionType=updateAll
 
Name
Required
Expected value
Compared by default
Compare method
Description
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
comp
false
chart; table; sheet
false
LIST
The component type requested by the client.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
height
true
 
false
 
The desired height, in pixels, of the component.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
imapGenerator
false
 
false
 
The image map generator which will be invoked to create the image map dynamically.
infoProviderMB
false
 
false
 
Method binding key to a method that accesses selection property.
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
request
true
 
false
 
The JViews Web request will be handled by server side.
selectionType
true
 
false
 
The type of selection.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
width
true
 
false
 
The desired width, in pixels, of the component.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
x
true
 
false
 
The x-coordinate of the clicked point in the image coordinate system.
y
true
 
false
 
The y-coordinate of the clicked point in the image coordinate system.
selectOneId
selectOneId selects the graphic object with the specified identifier. The current selection is cleared and the object specified by the id dentifier is selected.
Example URL: http://hostname:port/your_webapp_context/_contr?request=lightselect&id=node1&bbox=0%2C0%2C1%2C1&layer=Zip%20Areas%2CLabels%20For%3A%20Zip%20Areas%2CSymbols%2CLinks&selectionType=selectOneId&x=0&y=0&mouseUp=true&facesComponentId=xmapID&componentWidth=256&componentHeight=256&width=256&height=256&locale=en_US&facesService=forward&facesData=ilog.views.maps.servlet.IlvFacesGoogleViewServlet&again=Wed%252C%252005%2520Jan%25202011%252006%253A40%253A47%2520GMT%2520171
 
Name
Required
Expected value
Compared by default
Compare method
Description
again
false
 
false
 
A time stamp for the requests.
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
comp
false
chart; table; sheet
false
LIST
The component type requested by the client.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
height
true
 
false
 
The desired height, in pixels, of the component.
id
true
 
false
 
The identification of selected graphic object.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
infoProviderMB
false
 
false
 
Method binding key to a method that accesses selection property.
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
mouseUp
true
true; false
true
LIST
Determines whether it is mouse up.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
request
true
 
false
 
The JViews Web request will be handled by server side.
selectionType
true
 
false
 
The type of selection.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
width
true
 
false
 
The desired width, in pixels, of the component.
x
true
 
false
 
The x-coordinate of the clicked point in the image coordinate system.
y
true
 
false
 
The y-coordinate of the clicked point in the image coordinate system.
selectMultiId
SelectMultiId selects the graphic object with the specified identifier. The current selection is kept and if the object specified by the id identifier is already selected, it is removed from the current selection. Otherwise, it is added to the current selection.
Example URL: http://hostname:port/your_webapp_context/_contr?request=lightselect&bbox=-213.97276833274145%2C0%2C770.9455366654829%2C573.0000610351562&width=740&height=550&layer=InvisibleCompositeParts,Subnetworks,Groups,Standalone_Cards,Standalone_Shelf_Items,Standalone_Card_Items,Shelves,Shelf_Items,Card_Items,Ports,Links,BTS_Antennas,Main_Layer,Secondary_State_Modifiers,Alarm_Balloons,Information_Windows,System_Windows&tiled=true&facesData=ilog.tgo.faces.equipment.dhtml.servlet.IltFacesEquipmentServlet&facesService=forward&facesComponentId=example22&context=%23%7BdefContext%7D&locale=en_US&componentWidth=740&componentHeight=550&dynamic=true&selectionType=selectMultiId&id=CompositeCard0
 
Name
Required
Expected value
Compared by default
Compare method
Description
bbox
false
0
false
 
The rectangle that contains all the graphic objects.
comp
false
chart; table; sheet
false
LIST
The component type requested by the client.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
height
true
 
false
 
The desired height, in pixels, of the component.
id
true
 
false
 
The identification of selected graphic object.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
infoProviderMB
false
 
false
 
Method binding key to a method that accesses selection property.
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
request
true
 
false
 
The JViews Web request will be handled by server side.
selectionType
true
 
false
 
The type of selection.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
width
true
 
false
 
The desired width, in pixels, of the component.
setProperties
setProperties updates the server-side objects with any property changes.
Example URL: http://hostname:port/your_webapp_context/_contr?request=lightselect&comp=sheet&width=459&height=384&vpos=0&facesService=forward&facesData=ilog.views.gantt.faces.dhtml.servlet.IlvFacesGanttServlet&facesComponentId=gantt&locale=en_US&infoProviderMB=%23%7BganttBean.propertyAccessor%7D&selectionType=setProperties
 
Name
Required
Expected value
Compared by default
Compare method
Description
bbox
false
0
false
 
The rectangle that contains all the graphic objects.
comp
false
chart; table; sheet
false
LIST
The component type requested by the client.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
height
true
 
false
 
The desired height, in pixels, of the component.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
infoProviderMB
false
 
false
 
Method binding key to a method that accesses selection property.
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
request
true
 
false
 
The JViews Web request will be handled by server side.
selectionType
true
 
false
 
The type of selection.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
vpos
false
 
false
 
The vertical scroll position used in JViews Gantt.
width
true
 
false
 
The desired width, in pixels, of the component.
Available requests for JViews Diagrammer, JViews Maps and JViews TGO
JViews Diagrammer, JViews Maps and JViews TGO share the same types of requests.
For detailed information on Servlet/Servlet support classes, see Servlet and component classes.
The following sections provide tables of possible parameters with their expected values for each request. If a parameter must exist in a request, this is indicated by a value true in the Required column.. The Expected value column gives predefined options in JViews components. When security checking is enabled, these expected values are compared with the values sent by the user request. A true value in the Compared by default column indicates that the comparison is performed by default.
image
image is the request for image generation.
Example URL: http://hostname:port/your_webapp_context/_contr?request=image&layer=Links,Nodes&bbox=18.744629%2C-88.20932004101562%2C772.064208890625%2C450.37078851953123&format=PNG&width=600&height=350&again=Wed%2C%2005%20Jan%202011%2006%3A49%3A19%20GMT%20271&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&componentWidth=600&componentHeight=350&bgcolor=0xffffff
 
Name
Required
Expected value
Compared by default
Compare method
Description
action
false
 
false
 
The action name used for server action listener.
again
false
 
false
 
A time stamp for the requests
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
bgcolor
false
 
false
 
The background color.
css
false
 
false
 
The style sheet.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dataSourceId
false
 
false
 
The ID of a predefined data source.
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
expired
false
 
false
 
Determines whether the content is expired.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesDataSourceId
false
 
false
 
The identifier of the data source in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
format
true
JPEG; PNG; GIF; JPG
true
LIST
The image format response on the client side.
height
true
 
false
 
The desired height, in pixels, of the component.
imapGenerator
false
 
false
 
The image map generator which will be invoked to create the image map dynamically.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
overview
false
true; false
true
LIST
Determines whether it is an overview request.
project
false
 
false
 
The project file.
request
true
 
false
 
The JViews Web request will be handled by server side.
slc
false
 
false
 
The static layers count.
stylesheets
false
 
false
 
Comma-separated list of URLs of style sheets.
tile
false
 
false
 
The tile size.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
transparent
false
true; false
true
 
Determines whether the layer is transparent.
width
true
 
false
 
The desired width, in pixels, of the component.
imageMap
image is the request for image map generation
Example URL: http://hostname:port/your_webapp_context/_contr?request=imagemap&layer=Links,Nodes&bbox=-6.5585938%2C-855.3141540727343%2C2958.25341801875%2C2366.6027344149998&format=PNG&width=500&height=400&again=Wed%2C%2005%20Jan%202011%2006%3A49%3A53%20GMT%20100&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&componentWidth=500&componentHeight=400&bgcolor=0xffffff&image=http%3A//localhost%3A8082/jsf-diagrammer-gallery/_contr%3FfacesService%3Dforward%26facesData%3Dres%26v%3D8.7.0.7%26res%3D%24res%24/jviews/images/empty.gif
 
Name
Required
Expected value
Compared by default
Compare method
Description
again
false
 
false
 
A time stamp for the requests
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
bgcolor
false
 
false
 
The background color.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
format
true
JPEG; PNG; GIF; JPG
true
LIST
The image format response on the client side.
height
true
 
false
 
The desired height, in pixels, of the component.
image
false
script
false
NOT_CONTAINS
The empty image path, and no <script> element can be included.
imapGenerator
false
 
false
 
The image map generator which will be invoked to create the image map dynamically.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
request
true
 
false
 
The JViews Web request will be handled by server side.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
width
true
 
false
 
The desired width, in pixels, of the component.
capabilities
capabilities is the request for the manager’s capabilities.
Example URL: http://hostname:port/your_webapp_context/_contr?request=capabilities&format=json&width=500&height=400&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&action=imageModeAction%28false%29&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&project=/data/diagrammer.idpr&slc=undefined&componentWidth=500&componentHeight=400&again=Wed%2C%2005%20Jan%202011%2006%3A49%3A52%20GMT%20936
 
Name
Required
Expected value
Compared by default
Compare method
Description
action
false
 
false
 
The action name used for server action listener.
again
false
 
false
 
A time stamp for the requests
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
css
false
 
false
 
The style sheet.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dataSourceId
false
 
false
 
The ID of a predefined data source.
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
expired
false
 
false
 
Determines whether the content is expired.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesDataSourceId
false
 
false
 
The identifier of the data source in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
format
true
json
true
EQUALS
The capabilities request needs json format.
height
true
 
false
 
The desired height, in pixels, of the component.
infoProviderMB
false
 
false
 
Method binding key to a method that accesses the selection property.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
overview
false
true; false
true
LIST
Determines whether it is an overview request.
project
false
 
false
 
The project file.
properties
false
 
false
 
An object of properties containing keys and values for each of the property to be set at creation time.
request
true
 
false
 
The JViews Web request will be handled by server side.
slc
false
 
false
 
The static layers count.
stylesheets
false
 
false
 
Comma-separated list of URLs of style sheets.
tile
false
 
false
 
The tile size.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
transparent
false
true; false
true
 
Determines whether the layer is transparent.
width
true
 
false
 
The desired width, in pixels, of the component.
dynamicAction
dynamicAction restores the context and executes actions without generating an image.
Example URL: http://hostname:port/your_webapp_context/_contr?request=dynamicAction&layer=Links,Nodes&bbox=18.744629%2C-88.20932004101562%2C772.064208890625%2C450.37078851953123&format=PNG&width=600&height=350&again=Wed%2C%2005%20Jan%202011%2006%3A49%3A19%20GMT%20271&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&componentWidth=600&componentHeight=350&bgcolor=0xffffff
 
Name
Required
Expected value
Compared by default
Compare method
Description
action
false
 
false
 
The action name used for server action listener.
again
false
 
false
 
A time stamp for the requests
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
bgcolor
false
 
false
 
The background color.
css
false
 
false
 
The style sheet.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dataSourceId
false
 
false
 
The ID of a predefined data source.
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
expired
false
 
false
 
Determines whether the content is expired.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesDataSourceId
false
 
false
 
The identifier of the data source in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
format
true
JPEG; PNG; GIF; JPG
true
LIST
The image format response on the client side.
height
true
 
false
 
The desired height, in pixels, of the component.
imapGenerator
false
 
false
 
The image map generator which will be invoked to create the image map dynamically.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
overview
false
true; false
true
LIST
Determines whether it is an overview request.
project
false
 
false
 
The project file.
request
true
 
false
 
The JViews Web request will be handled by server side.
slc
false
 
false
 
The static layers count.
stylesheets
false
 
false
 
Comma-separated list of URLs of style sheets.
tile
false
 
false
 
The tile size.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
transparent
false
true; false
true
 
Determines whether the layer is transparent.
width
true
 
false
 
The desired width, in pixels, of the component.
hitmap
hitmap The hitmap request.
Example URL: http://hostname:port/your_webapp_context/_contr?request=hitmap&layer=Links,Nodes&bbox=-6.5585938%2C-855.31415752%2C2958.2533938%2C2366.60271504&width=500&height=400&again=Wed%2C%2005%20Jan%202011%2006%3A52%3A39%20GMT%20306&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&componentWidth=500&componentHeight=400
 
Name
Required
Expected value
Compared by default
Compare method
Description
again
false
 
false
 
A time stamp for the requests
bbox
false
 
false
 
The rectangle that contains all the graphic objects.
componentHeight
false
 
false
 
The desired height, in pixels, of the component used in a JSF environment.
componentWidth
false
 
false
 
The desired width in pixels of the component used in a JSF environment.
context
false
 
false
 
The binding to a JViews TGO context bean
dynamic
false
true; false
true
LIST
Determines whether it is a dynamic layer.
expired
false
 
false
 
Determines whether the content is expired.
facesComponentId
false
 
false
 
The ID of this component used under in a JSF environment.
facesData
false
 
false
 
The class of the servlet that generates the pop-up menu used in a JSF environment.
facesService
false
forward
true
EQUALS
The service to be handled by control servlet used in a JSF environment.
height
true
 
false
 
The desired height, in pixels, of the component.
imapGenerator
false
 
false
 
The image map generator which will be invoked to create the image map dynamically.
jviewsPageId
false
 
false
 
Page identification from the request (when the multi-tab page feature is enabled).
layer
false
 
false
 
A comma-separated list of names of the visible layers.
locale
false
 
false
 
The expected locale sent by client.
namespace
false
 
false
 
The portlet namespace
objectActionMB
false
 
false
 
Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
overview
false
true; false
true
LIST
Determines whether it is an overview request.
project
false
 
false
 
The project file.
request
true
 
false
 
The JViews Web request will be handled by server side.
tile
false
 
false
 
The tile size.
tiled
false
true; false
false
LIST
Determines whether the view is tiled.
tileMgr
false
 
false
 
The tile manager is responsible for retrieving or storing image tiles on the server side.
width
true
 
false
 
The desired width, in pixels, of the component.

Copyright © 2018, Rogue Wave Software, Inc. All Rights Reserved.