Errors when trying to import a custom report template into Control Compliance Suite (CCS)

book

Article ID: 156700

calendar_today

Updated On:

Products

Control Compliance Suite Windows

Issue/Introduction

When importing a customized report template into Control Compliance Suite (CCS), you are presented with an error about unexpected parameters.

 

Example error on template import attempt: 

The expected parameters are:
1.) AssetGroup
2.) Folders
3.) AssetJobID
4.) StandardJobID
5.) Top
6.) ReportRunBy
7.) ReportRunDate
8.) ReportJobName

The following extra parameters were found in the report template:
1.) @asset_attr1
2.) @asset_attr2
3.) @asset_attr3
4.) @asset_attr4
5.) @asset_attr5
6.) @asset_attr6
7.) @asset_attr7
8.) @asset_attr8
9.) @asset_attr9
10.) @asset_attr10
Specify a valid report template.

 

Cause

The specific error above was encountered when trying to import a customized Standard based template.  The list of expected parameters in the error are the parameters that CCS expects to have referenced in a Standard based report template.  The list of unexpected parameters refers to additional parameters that are required to be passed to the report during run time in order to resolve the values of fields that have been added to the report.  Report templates that require parameters beyond those expected are not importable into CCS 

Most likely a value in the DETAIL row of the report contains fields that require a parameter to be passed to the field before that field can resolve to a fixed value during run time.   The particular AttrX_string  string fields indicated in the error above are ones that are defined by the  usp_GetNonBaseAssetAttributes stored procedure in the CSM_Reports database.   In this particular case someone has used parameters from this procedure as field values in the DETAIL row of the report.  CCS does not recognize these parameters and therefore at run time cannot determine what the value of the parameter would be.  Report templates can only require parameters that are listed in the acceptable parameters for the specific type of template being imported (see information below).  

The information below specifies the list of predefined and mandatory parameters (in CCS 10.x.x) that must and can be present on a user defined template for the particular type of business object business object that the template is built on: 

 *******************************************************

 
Asset or Asset Group:

Parameter Name
Description
AssetJobID
This parameter will be set to a unique identifier value to be used for joining assets related data tables in the CSM_Reports database with the ReportJob table in the CSM_Reports database.
AssetGroup
This parameter will take the ID of the asset group which will be present in the scope of the report
Folders
This parameter will take in the ID of the folder in the asset system that needs to be used as scope in the report
ReportRunBy
The name of the user who executed the reporting job for this report
ReportRunDate
The date on which the reporting job was run for this report.

 
Standards:

Parameter Name
Description
StandardJobID
This parameter will be set to a unique identifier value used to join standards related tables in the CSM_Reports database with the ReportStandardJob table in the CSM_Reports database.
ReportRunBy
The name of the user who executed the reporting job for this report.
ReportRunDate
The date on which the reporting job was run for this report.

 
For reports that combine Assets and Standards business object the user will have to specify all parameters that are mandatory for the Asset business object as well as those mandatory for the Standard business object.
The ReportRunBy and ReportRunDate parameter must appear only once on the report.
 
Entitlements Control Points:

Parameter Name
Description
ControlPointType
The display name of the control point type for e.g. symc-wnt-file.
Status
The status of the control point
DataOwner
The owner of the control point.
Tags
The tags associated with the control point.
EntitlementsControlPointJobID
This parameter will be set to a unique identifier value to be used for joining assets related data tables in the CSM_Reports database with the ReportJob table in the CSM_Reports database. This parameter is a part of the filter set definition XML that is used to filter out control point types.
ReportRunBy
The name of the user who executed the reporting job for this report.
ReportRunDate
The date on which the reporting job was run for this report.
AssetGroup
The asset group to be used as scope in the report
Folders
The folders that will be used as scope in the report.

 

Entitlements Review Cycles:

Parameter Name
Description
CurrentOrSnapshotted
This parameter will determine whether the scope of the report contains the current review cycles or does it contain snapshot review cycles.
Status
The status of the review cycle
ReviewCycleID
The ID of the review cycle.
ControlPointType
The display name of the control point type for e.g. symc-wnt-file
DataOwner
The owner of the control point.
Tags
The tags associated with the control point.
EntitlementsReviewCycleJobID
This parameter will be set to a unique identifier value to be used for joining assets related data tables in the CSM_Reports database with the ReportJob table in the CSM_Reports database. This parameter is a part of the filter set definition XML that is used to filter out control point types.
ReportRunBy
The name of the user who executed the reporting job for this report.
ReportRunDate
The date on which the reporting job was run for this report.
AssetGroup
This parameter will take the ID of the asset group which will be present in the scope of the report
Folders
This parameter will take in the ID of the folder in the asset system that needs to be used as scope in the report

 
 Policy:

Parameter Name
Description
PolicyJobID
This parameter will be set to a unique identifier value to be used for joining policy related data tables in the CSM_Reports database with the PM_PolicyUser table in the CSM_Reports database.
ReportRunBy
The name of the user who executed the reporting job for this report.
ReportRunDate
The date on which the reporting job was run for this report.

 

 

Resolution

Only the expected parameters can be passed to the report by CCS at run time.  Any other additional field values in the report will need to be values that are fixed values from tables or calculations and cannot be ones that require additional parameters to be passed to the report before the value of the field can determined.

 


Applies To

Control Compliance Suite 9.0.1 and higher.

 

Attachments

User Defined Reports_WhitePaper_CCS_10 0.docx get_app