CP-66:Customize Standard Costpoint Reports Using Extensibility Designer

David McCallister,North Central Texas Council of Governments

CP-66: Customize Standard CostpointReports using Extensibility Designer

David McCallisterAgency Administration Information Systems ManagerNorth Central Texas Council of Governments

Agenda- Components of a Standard Costpoint Report

- Required Tools

- Simple Modifications (Report only – no extensions)

- Change Labels, Column Headings, Layout & Fields

- Modify Report Title or Status Text (User Interface only)

- Modify Title on the Report

- Complex Modifications (Requires Extensibility)

- Add Additional Columns to Main CP Report

Components of a Standard Costpoint 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 Application

An application is the top-level component that acts as the container to the screens inside the application. It does not contain any logic. UI and business logics are done entirely in the screens (result sets) and the java classes that supports them. You can only extend an application by changing its application name.

To view a list of all available applications in Costpoint, refer to the Apps folder of the Extensibility Designer’s Object Explorer. These applications are sorted by

application ID.

Report Parameter Result Set

A report parameter result set is the screen where the user selects various options to run the report. It is assigned underneath an application. In the example PPRPRRQ_PARAM is the parameter result set assigned to the Print Requisitions application.

Report Definition

A report definition (or report list) includes the metadata that describes a report such as title, status text, Java class action, and the data fields that feed into the report. In the Object explorer, you can find the report listed directly underneath the parameter result set.

In the example, the report definition for PPRPRRQ_PARAM is PPRPRRQ_RPT.

The name and location of the original report template is specified in the ROX (template) field on the Information tab (Extensibility Console). This path is a sub path underneath the root path where report templates for all applications reside in the Costpoint server. The root path for all report templates is:

\deltek\costpoint\71\applications\birt\report\bin. The example displays the report template for Print Requisitions at:

\deltek\costpoint\71\applications\birt\report\bin\commonpp\pprprrq\pprprrq.rptdesign

On the Data Sources tab, the left pane displays the data source ID and name used inside the report template. The right pane displays the ID of the data source result set which supplies the data for the report. In the following example, there is only one data source, and the ID is PPRPRRQ_DATA.

The Assigned to DS Variables tab includes all fields from the data source result set that have been selected to feed into the report. In the following example, all the columns from the data source result set are selected to be on the report.

You can extend a report definition by changing the title, status text, report template, action to be run before or after and the data source columns.

Data Source Result Set

The data source result set acts as a data source for the report. It is not displayed directly in the Object Explorer under the respective application branch. Take note of the ID of the data source result set in the Report Definition and find it using the Top Level Filter.

At the top of the RS list tab, there is usually a SQL Select statement defining where the data for the report will originate.

You can extend the data source result set by adding additional columns to the SQL select statement in the lower half of the SQL select panel. In this example, the name of the Approver from RQ_HDR_APPRVL is selected and joined with EMPL to display LAST_FIRST_NAME on the printed requisition.

Report Template

All report template files have the .rptdesignextension name. Copy the existing Costpoint template, save with a new name, then modify with the Eclipse IDE. The new template is placed in the custom folder (specified in the extended report definition) under the BIRT report main folder.

Required Tools

Required Tools

Costpoint 7.1 & BIRT Plug-ins

Extensibility License from Deltek –allows Costpoint customization

Eclipse 4.6.0 – tool to modify canned reports in Costpoint

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

- com.deltek.enterprise.system.reporting.client.birt.oda.designer_1.0.0.jar

- com.deltek.enterprise.system.reporting.client.birt.oda.runtime_1.0.0.jar

18

Simple Modifications

Modify Report Only – No Extensions

Requires Eclipse

Does 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, Alignment

20

• Adjust Page Size

• Show Header/Footer on First/Last Page

21

• Modify the Border

• Adjust Page Orientation (Auto/Landscape/Portrait)

22

• Adjust Font, Color, Size, Alignment, Location

• Adjust Margins

23

Complex Modifications

Add existing columns to Reports

Requires Extensibility License

Requires Eclipse

• Example – add name of approver to report

• Print Vendor List – aprvend.rptdesign

25

Extend Data Source Result Set

This change involves extending the report definition, making changes to the data source result set, and making changes to the report template.

26

Extend Report Definition

XT_AP_VEND_DD_1

1. Select the Report Definition for the report in the Extensibility Designer.

2. Extensibility Info tab – Change Title, Status, Currency, Actions Before/After, Page Setup.

Always Use Design Settings checked prevents user from overriding defaults.

27

Extend Data Source Result Set

Display 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_ID

From VEND_APVL_AUDIT_HS A

JOIN VEND B ON A.FRM_VEND_ID = B.VEND_ID

WHERE A.FRM_VEND_ID = :VEND_ID

28

Extend Data Source Result Set

Enter the same ID in the Report Variable field.

29

Extend Data Source Result Set

On the Report Definition Screen

Add new column to the list of variables for the report.

30

Extend a Report Template

The report template is not extended in the Extensibility Designer. Specify the new template name and location in the Report Definition extension and then use the Eclipse 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 fed into report from data source result set.

Body – content of the report. Cover page and table for detail report content. If edit or error report exist, there will be multiple tables.

Master Pages – generic info such as page number, heading etc.

31

Data Source

Outline view, select and expand the Data Sources section.

You can then view CP_DataSource as the 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 Eclipse

Expand the Data Set in Object Explorer – Right-Click the Data Set

Choose System Name

Select Extension

Select Report in Extension

Confirm Output Columns

34

Modify Report

Open aprvend.rptdesign

Modify Label

Add Approved By

Insert Data

35

Insert Data to Report

Insert Element – in the Outline

Select the Element to Insert.

In this example choose Data.

36

Insert Data to Report

Choose Data Type in the Edit Data Binding screen

Select ‘String’

Insert Expression from

available data sets

Double Click to insert.

37

Print Vendor List Report

Approved by now visible on the report

38

Print Purchase Requisition with Signature

• ppprprrq.rptdesign

• APPRVL_EMPL_IDadded to signature line

39

Extend Data Source Result Set - REQ

SELECT 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_NO

Add XT_APPROVED_BY as Report Variable in Extensibility Report Options (Currency and Report Tab)

Modify ppprprrq.rptdesign, connected to Eclipse add data source and insert XT_APPROVED_BY field above Signature Line. May require some adjustments for the first report.

40

Print PO with Signature

• porppo.rptdesign

• Added APPROVED_BYto the signature line

41

Extend Data Source Result Set - PO

SELECT APPRVL_USER_ID AS XT_APPRVL_USER_IDFROM PO_HDR WHERE PO_ID = :PO_ID AND PO_RLSE_NO = :PO_RLSE_NOAND PO_CHNG_ORD_NO = :PO_CHNG_ORD_NO

Add XT_APPRVL_USER_ID as Report Variable in Extensibility Report Options (Currency and Report Tab)

Modify porppo.rptdesign, connected to Eclipse add data source and insert field XT_APPRVL_USER_ID above Signature Line. May require some adjustments.

42

Print Change Order with Signature

• porpco.rptdesign

• Added APPROVED_BYto the signature line

43

Extend Data Source Result Set – PO Change Order

SELECT APPRVL_USER_ID AS XT_APPRVL_USER_IDFROM PO_HDR WHERE PO_ID = :PO_ID AND PO_RLSE_NO = :PO_RLSE_NOAND PO_CHNG_ORD_NO = :PO_CHNG_ORD_NO

Add XT_APPRVL_USER_ID as Report Variable in Extensibility Report Options (Currency and Report Tab)

Modify porpco.rptdesign, connected to Eclipse add data source and insert field XT_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 reports

45

Questions?

46

If you have any questions or need further assistance please contact:

David McCallisterEmail: dmccallister@nctcog.orgOffice: 817.695.9126