名称

ChangeSynergy::SubReportEntry


描述

ChangeSynergy::SubReportEntry 类是从服务器导入或导出报告时所使用的一部分类集合。所有 ReportEntry 对象都包含一个 QueryEntry 对象,以及一个或多个 SubReportEntry 对象。这些对象组成一个标准的 Change 报告配置项。该类表示“列”报告 CCM_PROBLEM 定义的 CCM_PROBLEM、CCM_TASK 或 CCM_OBJECT 项(如下所示)。

 [CCM_PROBLEM]
 	[NAME]column_cr[/NAME]
 	[MAIN_TEMPLATE]user_framework/column_rpt.html[/MAIN_TEMPLATE]
 	[HDR_TEMPLATE]user_framework/common_bulk_hdr.html[/HDR_TEMPLATE]
 	[ATTR_TEMPLATE]user_framework/column_attr.html[/ATTR_TEMPLATE]
 	[LABEL_TEMPLATE]user_framework/custom_label.html[/LABEL_TEMPLATE]
 	[AUTO_LABEL_TEMPLATE]user_framework/custom_auto_label.html[/AUTO_LABEL_TEMPLATE]
 	[SPAN_ATTR_TEMPLATE]user_framework/custom_span_attr.html[/SPAN_ATTR_TEMPLATE]
 	[AUTO_ATTR_TEMPLATE]user_framework/column_auto_attr.html[/AUTO_ATTR_TEMPLATE]
 	[FTR_TEMPLATE]user_framework/common_bulk_ftr.html[/FTR_TEMPLATE]
 	[ATTRS]problem_number:0:false|crstatus:1:false|problem_synopsis:2:false[/ATTRS]
 	[SORT_ORDER]problem_number:intb:A[/SORT_ORDER]
 [/CCM_PROBLEM]

示例:

 eval
 {
 	$csapi->setUpConnection("http", "machine", 8600);
	my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\machine\\ccmdb\\cm_database");
	#Construct a new Globals object.

	my $globals = new ChangeSynergy::Globals();
		
	#Export a CR report named 'My Report' from the shared preferences

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});
	

	my @subreports = $reportEntry->getSubReports();
	

	for my $subReportEntry (@subreports)
	{
		print "--------------- Sub Report Entry ---------------------\n";
		print "getName:                  " . $subReportEntry->getName() . "\n";
		print "getMainTemplate:          " . $subReportEntry->getMainTemplate() . "\n";
		print "getHeaderTemplate:        " . $subReportEntry->getHeaderTemplate() . "\n";
		print "getAttributeTemplate:     " . $subReportEntry->getAttributeTemplate() . "\n";
		print "getImageTemplate:         " . $subReportEntry->getImageTemplate() . "\n";
		print "getGroupTemplate:         " . $subReportEntry->getGroupTemplate() . "\n";
		print "getAutoAttributeTemplate: " . $subReportEntry->getAutoAttributeTemplate() . "\n";
		print "getFooterTemplate:        " . $subReportEntry->getFooterTemplate() . "\n";
		print "getGroupBy:               " . $subReportEntry->getGroupBy() . "\n";
		print "getCustomWslet:           " . $subReportEntry->getCustomWslet() . "\n";
		print "getXmlContent:            " . $subReportEntry->getXmlContent() . "\n";
		print "getSpanAttributeTemplate: " . $subReportEntry->getSpanAttributeTemplate() . "\n";
		print "getLabelTemplate:         " . $subReportEntry->getLabelTemplate() . "\n";
		print "getAutoLabelTemplate:     " . $subReportEntry->getAutoLabelTemplate() . "\n";
		print "getAttributes:            " . $subReportEntry->getAttributes() . "\n";
		print "getSortOrder:             " . $subReportEntry->getSortOrder() . "\n";
		print "getRelation:              " . $subReportEntry->getRelation() . "\n";
		print "getDefinitionType:        " . $subReportEntry->getDefinitionType() . "\n\n";
	}
 };
 if ($@)
 {
	print $@;
 }

方法概要

标量 getAttributes()

获取确定要查找的子报告属性的属性字符串 示例属性字符串为 problem_number:0:false|crstatus:1:false|problem_synopsis:2:false。
标量 getAttributeTemplate()

获取要装入的属性模板的名称,以格式化报告结果,例如 user_framework/column_attr.html。
标量 getAutoAttributeTemplate()

获取要装入的自动属性模板的名称,以格式化报告结果,例如 user_framework/custom_auto_attr.html。
标量 getAutoLabelTemplate()

获取要装入的自动标签模板的名称,以格式化报告结果,例如 user_framework/custom_auto_label.html。
标量 getCustomWslet()

获取为该子报告运行的定制 WSLET 的名称。
标量 getDefinitionType()

获取该子报告的定义类型(PROBLEM_DEF、TASK_DEF 或 OBJECT_DEF)。
标量 getFooterTemplate()

获取要装入的页脚模板的名称,例如 user_framework/common_bulk_ftr.html。
标量 getGroupBy()

获取包含如下所示属性名称的组:[GROUP_BY]attribute_name|sort_type:sort_direction[/GROUP_BY]。
标量 getGroupTemplate()

获取组模板的名称。
标量 getHeaderTemplate()

获取要装入的页眉模板的名称,以格式化报告结果,例如 user_framework/common_bulk_hdr.html。
标量 getImageTemplate()

获取要装入的图像模板的名称,以格式化报告结果,例如 user_framework/cs_chart_common_img.html。
标量 getLabelTemplate()

获取要装入的标签模板的名称,以格式化基于列的报告结果,例如 user_framework/custom_label.html。
标量 getMainTemplate()

获取要装入的主模板的名称,以格式化报告结果,例如 user_framework/column_rpt.html。
标量 getName()

获取子报告的名称,在上面的配置示例中,这是 NAME 标记中的数据。
标量 getRelation()

获取该子报告相关关系的名称。
标量 getSortOrder()

获取确定子报告项排序方式的排序顺序字符串 示例排序顺序字符串为 problem_number:intb:A。
标量 getSpanAttributeTemplate()

获取要装入的范围属性模板的名称,例如 user_framework/custom_span_attr.html。
标量 getXmlContent()

获取传递给定制 WSLET 的 XML 数据。
setAttributes(scalar attributes)

设置确定要查找的子报告属性的属性字符串 示例属性字符串为 problem_number:0:false|crstatus:1:false|problem_synopsis:2:false。
setAttributeTemplate(scalar attributeTemplate)

设置要装入的属性模板的名称,以格式化报告结果,例如 user_framework/column_attr.html。
setAutoAttributeTemplate(scalar autoAttributeTemplate)

设置要装入的自动属性模板的名称,以格式化自动生成报告的报告结果,例如 user_framework/custom_auto_attr.html。
setAutoLabelTemplate(scalar autoLabelTemplate)

设置要装入的自动标签模板的名称,以格式化自动生成报告的报告结果,例如 user_framework/custom_auto_label.html。
setCustomWslet(scalar customTemplate)

设置为该子报告运行的定制 WSLET 的名称,例如 CSChartMultipleDateTrend。
setDefinitionType(scalar definitionType)

设置该子报告的定义类型(PROBLEM_DEF、TASK_DEF 或 OBJECT_DEF)。
setFooterTemplate(scalar footerTemplate)

设置要装入的页脚模板的名称,例如 user_framework/common_bulk_ftr.html。
setGroupBy(scalar groupBy)

设置包含如下所示属性名称的组:[GROUP_BY]attribute_name|sort_type:sort_direction[/GROUP_BY]。
setGroupTemplate(scalar groupTemplate)

设置要装入的组模板的名称。
setHeaderTemplate(scalar headerTemplate)

设置要装入的页眉模板的名称,以格式化报告结果,例如 user_framework/common_bulk_hdr.html。
setImageTemplate(scalar imageTemplate)

设置要装入的图像模板的名称,以格式化报告结果,例如 user_framework/cs_chart_common_img.html。
setLabelTemplate(scalar labelTemplate)

设置要装入的标签模板的名称,以格式化基于列的报告结果,例如 user_framework/custom_label.html。
setMainTemplate(scalar mainTemplate)

设置要装入的主模板的名称,以格式化报告结果,例如 user_framework/column_rpt.html。
setName(scalar subReportName)

设置子报告的名称,这个名称是必需的,因为它链接报告定义和子报告定义。
setRelation(scalar relationName)

设置该子报告相关关系的名称,例如 associated_task。
setSortOrder(scalar sortOrder)

获取确定子报告项排序方式的排序顺序字符串 示例排序顺序字符串为 problem_number:intb:A。
setSpanAttributeTemplate(scalar spanAttributeTemplate)

设置当属性应该涵盖整个行时要装入的范围属性模板的名称,例如 user_framework/custom_span_attr.html。
setXmlContent(scalar xmContent)

设置发送到定制 WSLET 的 XML 数据。


方法


getAttributes

获取要包含在报告中的属性的分隔列表。常用语法为:attribute_name:sort_position:span_option,其中 sort_postion 和 span_option 是可选的。

 返回:标量
属性字符串列表。	


getAttributeTemplate

获取要装入的属性模板的名称,以格式化报告结果,例如 user_framework/column_attr.html。 属性模板重复用于报告中的每个项目,并打印关于项目属性的信息。模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
属性模板的名称。


getAutoAttributeTemplate

获取要装入的自动属性模板的名称,以格式化自动生成的报告结果,例如 user_framework/custom_auto_attr.html。 自动属性模板重复用于报告中的每个项目,并打印关于项目属性的信息。模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
自动属性模板的名称。


getAutoLabelTemplate

获取要装入的自动标签模板的名称,以格式化自动生成的报告结果,例如 user_framework/custom_auto_label.html。 自动标签模板允许您标注包含多个值的列,而不是格式化包含标签和值对的报告。模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
自动属性模板的名称。


getCustomWslet

获取为该子报告运行的定制 WSLET 的名称。

 返回:标量
要执行的定制 WSLET 的名称。


getDefinitionType

获取该子报告的定义类型(PROBLEM_DEF、TASK_DEF 或 OBJECT_DEF)。

 返回:标量
报告的定义类型。	


getFooterTemplate

获取要装入的页脚模板的名称,例如 user_framework/common_bulk_ftr.html。 一次性将页脚模板添加到报告底部。模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
页脚模板的名称。


getGroupBy

获取包含以下属性名称的组:attribute_name|sort_type:sort_direction,或仅一个属性名。

 返回:标量
属性分组字符串。	


getGroupTemplate

获取要装入的组模板的名称。分组模板允许根据分组的项绘制图表。 模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
组模板的名称。


getHeaderTemplate

获取要装入的页眉模板的名称,以格式化报告结果,例如 user_framework/common_bulk_hdr.html。 页眉模板一般包含报告最顶部显示的所有信息。模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
页眉模板的名称。


getImageTemplate

获取要包含在报告结果中的图像模板的名称,例如 user_framework/cs_chart_common_img.html。 图像模板一般包含一个图像或图表,而且仅包含在报告输出中一次。模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
图像模板的名称。


getLabelTemplate

获取列格式化报告的标签模板的名称。该模板允许您标注包含多个值的列,而不是格式化包含标签和值对的报告,例如 user_framework/custom_label.html。模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
主模板的名称。


getMainTemplate

获取要装入的主模板的名称,以格式化报告结果,例如 user_framework/column_rpt.html。 模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
主模板的名称。


getName

获取子报告的名称,该名称将不会显示在界面中,但是它将 CCM_REPORT 定义和 CCM_PROBLEM、CCM_TASK 或 CCM_OBJECT 定义链接起来,因此是必需的。

 返回:标量
子报告的名称。


getRelation

获取该子报告相关关系的名称(例如 associated_task),以查找变更请求的相关任务。

 返回:标量
关系的名称。	


getSortOrder

获取确定子报告项排序方式的排序顺序字符串 示例排序顺序字符串为 problem_number:intb:A。

 返回:标量
排列顺序属性字符串列表。


getSpanAttributeTemplate

获取要装入的范围属性模板的名称,以格式化报告结果,例如 user_framework/custom_span_attr.html。 范围属性模板重复用于在报告中跨整行的每个项目,并打印关于项目属性的信息。模板路径以“wsconfig/templates/pt/reports”开头。

 返回:标量
范围属性模板的名称。


getXmlContent

获取传递给定制 WSLET 的 XML 数据。

 返回:标量
适用于定制	WSLET 的 XML 数据。


setAttributes

设置要包含在报告中的属性的分隔列表。常用语法为:attribute_name:sort_position:span_option,其中 sort_postion 和 span_option 是可选的。

 参数:
标量:要设置的属性的分隔列表。	
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setAttributes("problem_number:0:false|crstatus:1:false|problem_synopsis:2:false");


setAttributeTemplate

设置要装入的属性模板的名称,以格式化报告结果,例如 user_framework/column_attr.html。 属性模板重复用于报告中的每个项目,并打印关于项目属性的信息。模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的属性模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setAttributeTemplate("user_framework/column_attr.html");


setAutoAttributeTemplate

设置要装入的自动标签模板的名称,以格式化自动生成的报告结果,例如 user_framework/custom_auto_label.html。 自动标签模板允许您标注包含多个值的列,而不是格式化包含标签和值对的报告。模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的自动属性模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setAutoAttributeTemplate("user_framework/custom_auto_label.html");


setAutoLabelTemplate

设置要装入的自动属性模板的名称,以格式化自动生成的报告结果,例如 user_framework/custom_auto_attr.html。 自动属性模板重复用于报告中的每个项目,并打印关于项目属性的信息。模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的自动标签模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setAutoLabelTemplate("user_framework/custom_auto_attr.html");


setCustomWslet

设置为该子报告运行的定制 WSLET 的名称,例如 CSChartMultipleDateTrend。

 参数:
标量:为该子报告运行的定制	WSLET 的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setCustomWslet("CSChartMultipleDateTrend");


setDefinitionType

获取该子报告的定义类型(PROBLEM_DEF、TASK_DEF 或 OBJECT_DEF)。

 参数:
标量:报告的定义类型。	
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setDefinitionType("PROBLEM_DEF");


setFooterTemplate

设置要装入的页脚模板的名称,例如 user_framework/common_bulk_ftr.html。 一次性将页脚模板添加到报告底部。模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的页脚模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setFooterTemplate("user_framework/common_bulk_ftr.html");


setGroupBy

设置包含以下属性名称的组:attribute_name|sort_type:sort_direction,或仅一个属性名。

 参数:
标量:按属性字符串划分的组。	
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setGroupBy("assigner");


setGroupTemplate

设置要装入的组模板的名称。分组模板允许根据分组的项绘制图表。 模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的组模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setGroupTemplate("user_framework/groupTemplate.html");


setHeaderTemplate

设置要装入的页眉模板的名称,以格式化报告结果,例如 user_framework/common_bulk_hdr.html。 页眉模板一般包含报告最顶部显示的所有信息。模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的页眉模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setHeaderTemplate("user_framework/common_bulk_hdr.html");


setImageTemplate

设置要包含在报告结果中的图像模板的名称,例如 user_framework/cs_chart_common_img.html。 图像模板一般包含一个图像或图表,而且仅包含在报告输出中一次。模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的图像模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setImageTemplate("user_framework/cs_chart_common_img.html");


setLabelTemplate

设置列格式化报告的标签模板的名称。该模板允许您标注包含多个值的列,而不是格式化包含标签和值对的报告,例如 user_framework/custom_label.html。模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的标签模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setLabelTemplate("wsconfig/templates/pt/reports");


setMainTemplate

设置要装入的主模板的名称,以格式化报告结果,例如 user_framework/column_rpt.html。 模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的主模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setMainTemplate("user_framework/column_rpt.html");


setName

设置子报告的名称,该名称将不会显示在界面中,但是它将 CCM_REPORT 定义和 CCM_PROBLEM、CCM_TASK 或 CCM_OBJECT 定义链接起来。

 参数:
标量:子报告在创建时应该具有的名称。	
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];

	$firstSubReport->setName("my sub report");


setRelation

设置该子报告相关关系的名称,例如 associated_task。

 参数:
标量:该子报告应该查找的关系的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setRelation("associated_task");


setSortOrder

获取确定子报告项排序方式的排序顺序字符串 示例排序顺序字符串为 problem_number:intb:A。

 参数:
标量:要设置的排序顺序属性的分隔列表。	
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setSortOrder("problem_number:intb:A");


setSpanAttributeTemplate

设置要装入的范围属性模板的名称,以格式化报告结果,例如 user_framework/custom_span_attr.html。 范围属性模板重复用于在报告中跨整行的每个项目,并打印关于项目属性的信息。模板路径以“wsconfig/templates/pt/reports”开头。

 参数:
标量:要装入的属性模板的名称。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setSpanAttributeTemplate("user_framework/custom_span_attr.html");


setXmlContent

设置发送到定制 WSLET 的 XML 数据。

 参数:
标量:适用于定制	WSLET 的 XML 内容。
 示例:
	

	my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});

	my @subreports = $reportEntry->getSubReports();

	my $firstSubReport = $subreports[0];
	$firstSubReport->setCustomWslet(XML DATA);