Transcription
CP-66:Customize StandardCostpoint Reports UsingExtensibility DesignerDavid McCallister,North Central Texas Council of Governments
CP-66: Customize Standard CostpointReports using Extensibility DesignerDavid McCallisterAgency Administration Information Systems ManagerNorth Central Texas Council of Governments
Agenda-Components of a Standard Costpoint ReportRequired ToolsSimple Modifications (Report only – no extensions)Change Labels, Column Headings, Layout & FieldsModify Report Title or Status Text (User Interface only)Modify Title on the ReportComplex Modifications (Requires Extensibility)Add Additional Columns to Main CP Report
Components of a StandardCostpoint Report
Components of a Standard CP Report Report application Report parameter result set Report definition(and Java classes that populate the data for the report) Data source result set (with Select SQL) Report template
Report ApplicationAn application is the top-levelcomponent that acts as thecontainer to the screens inside theapplication. It does not contain anylogic. UI and business logics aredone entirely in the screens (resultsets) and the java classes thatsupports them. You can only extendan application by changing itsapplication name.To view a list of all availableapplications in Costpoint, refer tothe Apps folder of the ExtensibilityDesigner’s Object Explorer. Theseapplications are sorted byapplication ID.
Report ParameterResult SetA report parameterresult set is the screenwhere the user selectsvarious options to runthe report. It is assignedunderneath anapplication. In theexamplePPRPRRQ PARAM is theparameter result setassigned to the PrintRequisitions application.
Report DefinitionA report definition (or reportlist) includes the metadatathat describes a report suchas title, status text, Java classaction, and the data fieldsthat feed into the report. Inthe Object explorer, you canfind the report listed directlyunderneath the parameterresult set.In the example, the reportdefinition forPPRPRRQ PARAM isPPRPRRQ RPT.
The name and location of theoriginal report template isspecified in the ROX (template)field on the Information tab(Extensibility Console). This path isa sub path underneath the rootpath where report templates forall applications reside in theCostpoint server. The root path forall report templates in. The exampledisplays the report template forPrint Requisitions in\commonpp\pprprrq\pprprrq.rptdesign
On the Data Sources tab, theleft pane displays the datasource ID and name usedinside the report template.The right pane displays the IDof the data source result setwhich supplies the data forthe report. In the followingexample, there is only onedata source, and the ID isPPRPRRQ DATA.
The Assigned to DS Variablestab includes all fields from thedata source result set thathave been selected to feedinto the report. In thefollowing example, all thecolumns from the data sourceresult set are selected to beon the report.You can extend a reportdefinition by changing thetitle, status text, reporttemplate, action to be runbefore or after and the datasource columns.
Data Source Result SetThe data source result setacts as a data source forthe report. It is notdisplayed directly in theObject Explorer under therespective applicationbranch. Take note of theID of the data sourceresult set in the ReportDefinition and find it usingthe Top Level Filter.
At the top of the RS listtab, there is usually a SQLSelect statement definingwhere the data for thereport will originate.
You can extend the datasource result set byadding additional columnsto the SQL selectstatement in the lowerhalf of the SQL selectpanel. In this example,the name of the Approverfrom RQ HDR APPRVL isselected and joined withEMPL to displayLAST FIRST NAME on theprinted requisition.
Report TemplateAll report template fileshave the .rptdesignextension name. Copythe existing Costpointtemplate, save with a newname, then modify withthe Eclipse IDE. The newtemplate is placed in thecustom folder (specified inthe extended reportdefinition) under the BIRTreport main folder.
Required Tools
Costpoint 7.1 & BIRT Plug-insRequired ToolsEclipse 4.6.0 – tool to modifycanned reports in CostpointExtensibility License from Deltek –allows Costpoint customization
Eclipse Eclipse 4.6.0- 32 or 64-bit version available- Use matching 32 or 64-bit JDK Open Source software that allows changes to canned CP reports The Deltek Costpoint BIRT Plug-in (below) is necessary to edit any Costpoint reports DeltekCostpoint711BIRTInstaller Build05.exe (DSM)- Installs Deltek supplied plugins that allow Eclipse IDE to work with Costpoint- .oda.designer 1.0.0.jar- .oda.runtime 1.0.0.jar18
Simple Modifications
Modify Report Only – No ExtensionsRequires EclipseDoes NOT require Extensibility License Adjust Page Size Show header on first footer on last page Add/Change Border Adjust Page Orientation Adjust Margins Adjust Font Size, Color, Location, Alignment20
Adjust Page Size Show Header/Footer on First/Last Page21
Modify the Border Adjust Page Orientation (Auto/Landscape/Portrait)22
Adjust Font, Color, Size, Alignment, Location Adjust Margins23
Complex Modifications
Add existing columns to ReportsRequires Extensibility LicenseRequires Eclipse Example – add name of approver to report Print Vendor List – aprvend.rptdesign25
Extend Data Source Result SetThis change involves extending thereport definition, making changes tothe data source result set, andmaking changes to the reporttemplate.26
Extend Report DefinitionXT AP VEND DD 11. Select the Report Definition for thereport in the Extensibility Designer.2. Extensibility Info tab – ChangeTitle, Status, Currency, ActionsBefore/After, Page Setup.Always Use Design Settings checkedprevents user from overridingdefaults.27
Extend Data Source Result SetDisplay the Edit Result Set Screen and add:Select A.FRM VEND ID as XT FRM VEND ID,A.ENTR USER ID as XT ENTR USER ID,A.TIME STAMP as XT TIME STAMP,B.VEND ID AS XT VEND IDFrom VEND APVL AUDIT HS AJOIN VEND B ON A.FRM VEND ID B.VEND IDWHERE A.FRM VEND ID :VEND ID28
Extend Data Source Result SetEnter the same ID in the ReportVariable field.29
Extend Data Source Result SetOn the Report Definition ScreenAdd new column to the list ofvariables for the report.30
Extend a Report TemplateThe report template is not extended in the Extensibility Designer. Specify the newtemplate name and location in the Report Definition extension and then use theEclipse IDE to design the changes.The main components of a Costpoint report are:Data Sources – receives from CP Application server (BIRT plugins connect)Data Sets – data setup in report definition. Defines which columns (fields) are fedinto report from data source result set.Body – content of the report. Cover page and table for detail report content. If editor error report exist, there will be multiple tables.Master Pages – generic info such as page number, heading etc.31
Data SourceOutline view, select and expand theData Sources section.You can then view CP DataSource asthe single data source for the report.32
Data Set Expand the Data Set folder in outline view Generally, for each data source result set assigned to the report,there is a Data Set in this folder. In this example, there is only one Data Set, APRVEND Data Set.33
Confirm Data Set in EclipseExpand the Data Set in ObjectExplorer – Right-Click the Data SetChoose System NameSelect ExtensionSelect Report in ExtensionConfirm Output Columns34
Modify ReportOpen aprvend.rptdesignModify LabelAdd Approved ByInsert Data35
Insert Data to ReportInsert Element – in the OutlineSelect the Element to Insert.In this example choose Data.36
Insert Data to ReportChoose Data Type in the Edit DataBinding screenSelect ‘String’Insert Expression fromavailable data setsDouble Click to insert.37
Print Vendor List ReportApproved by now visible on the report38
Print Purchase Requisition with Signature ppprprrq.rptdesign APPRVL EMPL IDadded to signature line39
Extend Data Source Result Set - REQSELECT A.NAME AS XT APPROVED BYFROM W USER UGRP LIST AJOIN RQ HDR APPRVL B ON A.SEC OBJ ID B.APPRVL USER IDWHERE B.RQ ID :RQ ID AND B.APPRVL SEQ NO :APPRVL SEQ NOAdd XT APPROVED BY as Report Variable in Extensibility Report Options (Currency andReport Tab)Modify ppprprrq.rptdesign, connected to Eclipse add data source and insertXT APPROVED BY field above Signature Line. May require some adjustments for the firstreport.40
Print PO with Signature porppo.rptdesign Added APPROVED BYto the signature line41
Extend Data Source Result Set - POSELECT APPRVL USER ID AS XT APPRVL USER IDFROM PO HDR WHERE PO ID :PO IDAND PO RLSE NO :PO RLSE NOAND PO CHNG ORD NO :PO CHNG ORD NOAdd XT APPRVL USER ID as Report Variable in Extensibility Report Options (Currency andReport Tab)Modify porppo.rptdesign, connected to Eclipse add data source and insert fieldXT APPRVL USER ID above Signature Line. May require some adjustments.42
Print Change Order with Signature porpco.rptdesign Added APPROVED BYto the signature line43
Extend Data Source Result Set – PO Change OrderSELECT APPRVL USER ID AS XT APPRVL USER IDFROM PO HDR WHERE PO ID :PO IDAND PO RLSE NO :PO RLSE NOAND PO CHNG ORD NO :PO CHNG ORD NOAdd XT APPRVL USER ID as Report Variable in Extensibility Report Options (Currency andReport Tab)Modify porpco.rptdesign, connected to Eclipse add data source and insert fieldXT APPRVL USER ID above Signature Line. May require some adjustments.44
Summary Eclipse required to modify reports Modifications are made to reports on the application server All reports in Costpoint can be modified Requires knowledge of application name, reports used and file locations Modified reports can be stored elsewhere to avoid being overwritten Extensibility allows additional data to be added and incorporated into reports45
Questions?If you have any questions or need furtherassistance please contact:David McCallisterEmail: dmccallister@nctcog.orgOffice: 817.695.912646
Modifications are made to reports on the application server All reports in Costpoint can be modified Requires knowledge of application name, reports used and file locations Modified reports can be stored elsewhere to avoid being overwritten Extensibility allows additional data to be added and incorporated into reports 45
