Summarize-Groups
DESCRIPTION
Provides descriptive information about groups.
SYNTAX
<ie:webject name="Summarize-Groups" type="GRP">
<ie:param name="CLASS" data="class"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
</ie:webject>
PARAMETERS
|
Required
|
Select
|
Optional
|
|
GROUP_IN
|
|
CLASS
|
|
GROUP_OUT
|
|
|
CLASS
Specifies the type of the objects contained in the output group named by the GROUP_OUT parameter. For example if a webject specifies CLASS=MyClassName and GROUP_OUT=data_1, then the XML representation of the output group contains the following tags:
<MyClassName NAME="data_1" TYPE="Object" STATUS="0">
</MyClassName>
The default for this parameter is “Unknown-Class-Name.” This parameter is optional.
GROUP_IN
Specifies the groups to be summarized. Multiple values can be specified for this parameter. This parameter is required.
GROUP_OUT
Specifies the name of the results of summarizing the input groups. Each node or row has the following attributes:
NAME -- the name of the GROUP_IN
TYPE -- the type of the group (Unknown, Object, Status, or Stream)
SIZE -- currently 0
COUNT -- the number of elements in the group
MIMETYPE -- currently an empty string
MESSAGE -- the message, if any, associated with the group
STATUS -- the integer status associated with the group
This parameter is required.
EXAMPLE
The following example uses Summarize-Groups to provide descriptive information about the specified GROUP_IN and places the resulting data in an output group named “result”:
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<!-- Summarize the contents of a set of groups. -->
<ie:task uri="com/company/CreateGroup.xml"/>
<ie:task uri="com/company/CreateGroupHr.xml"/>
<ie:webject name="Summarize-Groups" type="GRP">
<ie:param name="GROUP_IN" data="createdgroup"/>
<ie:param name="GROUP_IN" data="createhrgroup"/>
<ie:param name="CLASS" data="SUMMARIZEGROUPS"/>
<ie:param name="GROUP_OUT" data="result"/>
</ie:webject>