Integrated Data & Reprting Integrated Data & Reprting Team idr@ithelp.uregn.edu idr.uregn.edu
Table f Cntents Reprt Standards Checklist... 4 Terms t knw... 4 Unlcking a Reprt... 4 Page Header... 4 Header Clumn 1 - Reprt Name and High-Level Parameter Respnses... 5 Header Clumn 2 - University f Oregn Lg... 5 Header Clumn 3 - Drill-thrugh links t Excel, PDF, r ther reprts... 6 Page Fter... 6 Fter Clumn 1 Versin number and date... 6 Fter Clumn 2 Page number... 6 Fter Clumn 3 Run date and time... 6 Reprt Bdy Style... 7 Reprt Bdy Paginatin... 8 Clumn Header Text... 9 Reprt Bdy Headers... 9 Data Frmats... 11 Date Frmat... 11 Dllar Amunt Frmat... 11 Percent Frmat... 11 Suppress Zer Value and Null Rws... 12 Prmpt Page... 12 Prmpt Page Header... 13 Prmpt Page Header Clumn 1 - University f Oregn Lg... 13 Prmpt Page Header Clumn 2 - Reprt Name... 13 Prmpt Page Header Clumn 3 Empty Placehlder t Center Page... 13 Prmpt Page Bdy... 14 Prmpt Bdy Clumn 1 Empty Placehlder t Center Page... 14 Prmpt Bdy Clumn 2 Prmpt Table and Buttns... 14 Prmpt Bdy Clumn 3 Empty Placehlder t Center Page... 14 Prmpt Table Style... 14 Parameter Frmats fr Financial Reprts... 15 Versin 3.1 Page 2 f 21 January 6, 2015
Parameter Frmats fr HR/Payrll Reprts... 16 Value Prmpts Cde and Descriptin... 16 Value Prmpts Display Text... 16 Text Prmpts... 17 Optinal Parameters Java script t warn user... 17 Reprt Help... 17 Clumn 1 Empty Placehlder t Center Page... 18 Clumn 2 University f Oregn Lg... 18 Clumn 3 Empty Placehlder t Center Page... 18 Reprt Name + Help... 18 Reprt Definitin... 19 HTML Item fr Help Cntent... 19 Cmments Page... 19 Drill-Thrugh Links... 20 Graphs... 21 View as PDF... 21 View as Excel... 21 Versining... 21 Questins? Cntact Integrated Data and Reprting... 21 Versin 3.1 Page 3 f 21 January 6, 2015
The intended audience includes University f Oregn Advanced Reprt Writers wh are develping Enterprise level reprts with Cgns Reprt Studi. Reprt Standards Checklist Page Header Page Fter Reprt Bdy Style Reprt Bdy Paginatin Clumn Header Text Reprt Bdy Headers Data Frmats Prmpt Page Reprt Help Drill-Thrugh Links Graphs View as PDF View as Excel Versining Terms t knw Integrated Data & Reprting (IDR) integrates the University's infrmatin resurces t supprt peratinal reprting and substantially imprve efficiency in analysis and frecasting. Data is refreshed nightly s reprts reflect the activity f the previus day. Cgns Reprt Studi is the mst advanced studi and is utilized fr develping cmplex reprts intended fr the UO Enterprise reprt flders. Reprt Writers Cllabratin flder is an area in Cgns that is available t all reprt writers fr use during develpment f reprts. Unlcking a Reprt T make changes t layut bjects yu may need t temprarily unlck the reprt. Use the padlck r frm the Structure menu >> Lck Page Objects Once the change has been made it is best t relck the reprt Page Header Delete the Duble-click t edit text text item and leave the header blck in place Drag a table int the header blck and make it 3 clumns and 1 rw. This table will be the placehlder fr these items: Clumn 1 Reprt Name and high level parameter respnses Clumn 2 University f Oregn Lg Clumn 3 Drill-thrugh links t Excel, PDF, r ther reprts Versin 3.1 Page 4 f 21 January 6, 2015
Header Clumn 1 - Reprt Name and High-Level Parameter Respnses Reprt Name Drag a table t clumn 1 and make it 1 clumn and 4 rws Rw 1 is fr the reprt name Drag a text item int rw 1 and type the reprt name. The name shuld be the same reprt name that users see in the Enterprise Flders. Nte: D nt use ReprtName() frmula because users change the name when saving a Reprt View Fnt: Arial, 10 pt, bld Left justify the cell High-level parameter respnses like Fiscal Year/Fiscal Perid r Term/Semester Rw 2 is a placehlder space belw the reprt name Drag a text item t rw 2 and type a space Rw 3 is fr text item Fiscal Year: plus the expressin ParamDisplayValue('p_FY') Rw 4 is fr text item Fiscal Perid: plus the expressin ParamDisplayValue('p_FP') Fnt: Arial, 10 pt, regular Left justify the cell Nte: Other parameter respnses like FOAPAL elements are nrmally used fr grupings and are displayed in the reprt bdy headers, cvered belw. Fr drill-thrugh reprts, always display the drill-thrugh value in the headers f the target reprt t retain the cntext f the data. Fr instance, if the user clicks Fund t drill-thrugh then include Fund in the header. Header Clumn 2 - University f Oregn Lg Drag an image bject frm the tlbx t clumn 2 in the header table Duble-click the image and the Image URL windw appears Click Brwse Select UO_Lg_Wide.jpg and click OK In the URL, remve everything befre /samples This creates a relative URL s when the reprt is prmted frm Test t Prd the lg remains in place. Versin 3.1 Page 5 f 21 January 6, 2015
In Prperties > Psitining > Size & Overflw, set the height t 50 px Center justify the cell Header Clumn 3 - Drill-thrugh links t Excel, PDF, r ther reprts Drag a table t clumn 3 and make it 1 clumn and 3 rws. Add apprpriate cntent starting in the lwest cell. Cntent can include drill-thrughs t special versins f Excel like the raw data flattened ut versin that users will nt get if they simply chse t run/view the reprt as Excel. Other cntent may be a special versin f PDF r drillthrughs t ther reprts when a drill-thrugh n a data item may nt make sense. Page Fter A 3 clumn by 1 rw table already exists in the default fter. We will use it fr the fllwing: Clumn 1 Versin number and date Clumn 2 Page number Clumn 3 Run date and time Fter Clumn 1 Versin number and date Drag the default date bject t clumn 3 and place it in frnt f the time bject Add a text item t Clumn 1 Type the versin number, a dash, and mnth/year. Versin 2.1-1/13 Fnt: Arial, 9 pt Left justify the cell Fter Clumn 2 Page number Drag a text item t clumn 2 and place it in frnt f the Page Number bject Type Page (add a space after Page) Leave the default number style as single page number Shift click the text item and the page bject and change t Arial, 9pt Center justify the cell Fter Clumn 3 Run date and time Right-click the date bject G t Style > Data Frmat Frmat type: Date Date Style: Shrt Versin 3.1 Page 6 f 21 January 6, 2015
Right-click the time bject G t Style > Data Frmat Frmat type: Time Time Style: Shrt Drag a text item between the date and time bjects Type a single space in the text bx Shift-click the date, text space, and time bjects and change t Arial, 9pt Right justify the cell Reprt Bdy Style Select the main table, list, r crsstab by selecting the 3 red dts in the upper left crner Table Menu >> Apply Table Style >> Cntemprary Versin 3.1 Page 7 f 21 January 6, 2015
Change any range sub-fter rws t light green Use the Pick up Style drpper t pick up the style frm a light green fter rw Then select the sub-fter clumn and select the Apply Style drpper Repeat fr all range sub-fter clumns Nte: Dark green = Red: 66, Green: 99, Blue: 66 Light green = Red: B3, Green: E2, Blue: 83 Change clumn header text frm light green t white Unlck the reprt t access the header text Click n a header clumn text Change t white Repeat fr all headers Relck the reprt This cntemprary style autmatically sets the table fters t the desired 9 pt, bld Reprt Bdy Paginatin By default Cgns displays a few rws f the reprt and then the user may need t scrll dwn t see the Page Up/Page Dwn links at the bttm f the windw. This can be very frustrating t users s set the rws per page t 9,999. Select the main table, list, r crsstab by selecting the 3 red dts in the upper left crner Set the rws per page t 9,999 in Prperties > Data > Rws per Page Versin 3.1 Page 8 f 21 January 6, 2015
Clumn Header Text Data items frm the data warehuse are upper case with underscres. T make them mre user friendly change them t upper and lwer case and change t the business name defined by the data wner. Fr instance, SUM_ENCUMBRANCES is changed t YTD Budget Cmmitted. Right-click the header and select Edit Data Item Label Type yur desired label in Data Item Label bx but d nt change Data Item Name Data item labels can als be changed in the Prperties > Data Item Reprt Bdy Headers Finance reprts ften have the FOAPAL elements in a header abve the main bdy f the reprt. In this Budget Status example, fields used as ptinal parameters are reflected in the reprt bdy header. Nte: Activity and Lcatin rws are set t hide if they are null. (If ([Query1].[ACTIVITY] is null) Then ('') Else ('Activity: ')) Versin 3.1 Page 9 f 21 January 6, 2015
Drag a table frm the tlbx t the main wrkspace and make it 1 clumn and 2 rws. (This helps t keep the data lcked in place when viewed as Excel r PDF.) Select the main reprt list r crsstab by selecting the 3 red dts in the upper left crner and drag it t rw 2 f the new table Drag a new table t rw 1 and make it 3 clumns and 7 rws Clumn 1 descriptive text items Clumn 2 data item cde Clumn 3 data item descriptin Set the clumns widths t either pixels r percentage in Prperties > Psitining > Size and Overflw. Yu may set just the tp rw f each clumn, r shift-click t select the entire clumn f cells. In this example, clumns 1 and 2 are set t 120 pixels wide and the third clumn desn t need t be set. When data items are added t this table yu may encunter this errr: Instead f creating a Singletn fr each data item yu can relate the entire page t Query 1 and then yu d nt need Singletn s. G t the Select Ancestr up buttn in the Prperties header bar and select Page G t Prperties > Data > Query and select Query1, r apprpriate query Versin 3.1 Page 10 f 21 January 6, 2015
Nw that the table structure has been set, add the reprt bdy header text items and data items Drag text items int clumn 1 and add descriptive text Drag data item cdes int clumn 2 Drag data item descriptins int clumn 3 Use the Table menu t insert r delete rws and clumns as needed Data Frmats Data items can be frmatted by right-clicking and selecting Style > Data Frmat Date Frmat Frmat example: 07-Feb-2013 Frmat type: Date Date Style: Medium Date Separatr: - Date Ordering: Day, Mnth, Year Dllar Amunt Frmat Frmat example: -4,991.10 Frmat type: Number N. f Decimal Places: 2 Exceptin: Display budgets with n decimal places Negative Sign Symbl: - Missing Value Characters (null): 0.00 Zer Value Characters: 0.00 Divide by Zer Characters: 0.00 Set amunts s they d nt wrap, Prperties > Fnt & Text > White Space > N wrap Be sure t als set the frmatting in the ttals Percent Frmat Frmat example: -12% Frmat type: Percent Versin 3.1 Page 11 f 21 January 6, 2015
Cgns defaults autmatically display percentages with a percent sign, n decimal places and - fr negative Missing Value Characters: - Zer Value Characters: - Divide by Zer Characters: - Suppress Zer Value and Null Rws T suppress zer values and null rws in the main table: Select the main table, list, r crsstab by selecting the 3 red dts in the upper left crner G t Prperties > Data > Suppressin Select Rws Leave default checkmarks in place Select OK Prmpt Page The default prmpt page has a light grey backgrund with buttns in the fter. Versin 3.1 Page 12 f 21 January 6, 2015
Prmpt Page Header Delete the Duble-click t edit text text item and leave the header blck in place Select the header and change t white Integrated Data and Reprting Use the backgrund clr buttn t change t white Drag a table int the header blck and make it 3 clumns and 1 rw. This table will be the placehlder fr these items: Clumn 1 University f Oregn Lg Clumn 2 Reprt Name Clumn 3 Empty placehlder t center page Prmpt Page Header Clumn 1 - University f Oregn Lg Select clumn 1 and in Prperties > Psitining > Size & Overflw, set the width t 33% Drag an image bject frm the tlbx t clumn 1 Duble-click the image and the Image URL windw appears Click Brwse Select UO_Lg_Wide.jpg and click OK In the URL, remve everything befre /samples This creates a relative URL s when the reprt is prmted frm Test t Prd the lg remains in place. In Prperties > Psitining > Size & Overflw, set the height t 50 px Left justify the cell Prmpt Page Header Clumn 2 - Reprt Name Reprt Name Drag a text item int clumn 2 and type the reprt name. The name shuld be the same reprt name that users see in the Enterprise Flders. Nte: D nt use ReprtName() frmula because users change the name when saving a Reprt View Fnt: Arial, 12 pt, bld Center justify the cell Prmpt Page Header Clumn 3 Empty Placehlder t Center Page Select clumn 3 and in Prperties > Psitining > Size & Overflw, set the width t 33% Versin 3.1 Page 13 f 21 January 6, 2015
Prmpt Page Bdy Select the page bdy and change t white Integrated Data and Reprting Drag a table int the page bdy and make it 3 clumns and 3 rws. This table will be the placehlder fr these items: Clumn 1 Empty placehlder t center page Clumn 2 Parameters and Buttns Clumn 3 Empty placehlder t center page Prmpt Bdy Clumn 1 Empty Placehlder t Center Page Shift-click the 3 rws in clumn 1 and in Prperties > Psitining > Size & Overflw, set the width t 33% Prmpt Bdy Clumn 2 Prmpt Table and Buttns Shift-click the 3 rws in clumn 2 and select center If yu already have a prmpt table, drag it t rw 1 in clumn 2. Prmpt table style is discussed belw. Drag a table int clumn 2 rw 3 and make it 3 clumns and 1 rw. This table will be the placehlder fr these items: Clumn 1 Reprt Help (discussed belw) Clumn 2 Cancel Buttn Clumn 3 Finish Buttn Unlck the prmpt page Pull Cancel buttn frm the prmpt page fter int clumn 2 Center justify the cell Pull the Finish buttn frm the prmpt page fter int clumn 3 Left justify the cell Delete the prmpt page fter which will als delete the Back and Next buttns Relck the prmpt page Prmpt Bdy Clumn 3 Empty Placehlder t Center Page Shift-click the 3 rws in clumn 3 and in Prperties > Psitining > Size & Overflw, set the width t 33% Prmpt Table Style Select the prmpt table by selecting the 3 red dts in the upper left crner Table Menu >> Apply Table Style >> Cntemprary Versin 3.1 Page 14 f 21 January 6, 2015
Change any range t dark green Use the Pick up Style drpper t pick up the style frm the dark green cells Then select an range cell and select the Apply Style drpper Repeat fr all range cells Nte: Dark green = Red: 66, Green: 99, Blue: 66 Light green = Red: B3, Green: E2, Blue: 83 Change prmpt descriptin text frm light green t white Click n the prmpt descriptin text Change t white Change t bld Repeat fr all prmpt descriptin text Parameter Frmats fr Financial Reprts Display red * indicating required prmpts (Cgns default) Fiscal Year, descending srt Fiscal Year shuld always be a required prmpt Set current Fiscal Year as the default in Prperties > General > Default Selectins Nte: The Data Owner will submit a request t Infrmatin Services when the default Fiscal Year shuld be changed. Fiscal Perid, ascending srt Other parameters in lgical rder Versin 3.1 Page 15 f 21 January 6, 2015
Parameter Frmats fr HR/Payrll Reprts Display red * indicating required prmpts (Cgns default) Year always the first parameter and named Calendar Year, descending srt Mnth always the secnd parameter and named Pay Number, ascending srt Timesheet Organizatin, if needed, the third parameter and named Organizatin Other parameters in lgical rder Value Prmpts Cde and Descriptin Fr FOAPAL elements, use Cde and Descriptin whenever pssible Example: 266500 (Hnrs Cllege) Create a Data Item Expressin in the query Example: OrgnDesc frmula, [ORGANIZATION_CODE] + ' (' + [ORGANIZATION_DESC] + ')' In Prperties > Data set the Data Item Expressin yu created as the Display Value Value Prmpts Display Text Change default display text frm Value_Descriptin t Select a Example: Select a Fiscal Year Select the Fiscal Year value prmpt Prperties > Prmpt Text > Header Text Select Specified text and In Default Text type Select a Fiscal Year Repeat fr Fiscal Perid and ther value prmpts Versin 3.1 Page 16 f 21 January 6, 2015
Text Prmpts Set text values t allw upper r lwer case entries by utilizing the Upper() functin. Integrated Data and Reprting Query filters example: ([Operating Ledger].[Operating Ledger].[ACCOUNT_INDEX] = Upper(?p_Index?)) Parameter display example: Upper(ParamDisplayValue('p_Index')) Optinal Parameters Java script t warn user If the reprt has mre than ne ptinal parameter, Java script must be applied s users cannt accidently create run-away queries. If the Index-t-FOAPAL re-prmpt is used, Java script t disable the Enter key must als be applied. Sample scripts are available in the Technical FAQ s at idr.uregn.edu. Reprt Help Reprt Help is a link t the reprt descriptin, explanatins abut the reprt parameters, and additinal infrmatin. It is a separate reprt with a simple drill-thrugh frm the parameter page f the main reprt. Always set the drill-thrugh t pen Reprt Help in a new windw. Create a new reprt Select Blank in the New windw Versin 3.1 Page 17 f 21 January 6, 2015
The data package must be the same as the main reprt package r users may encunter security errrs. Drag a table int the wrkspace and make it 1 clumn and 4 rws Drag anther table int rw 1 and make it 3 clumns and 1 rw This table will be the placehlder fr these items: Clumn 1 Empty Placehlder t Center Header Clumn 2 University f Oregn Lg Clumn 3 Empty Placehlder t Center Header Clumn 1 Empty Placehlder t Center Page Select clumn 1 in rw 1 and in Prperties > Psitining > Size & Overflw, set the width t 33% Clumn 2 University f Oregn Lg Drag an image bject frm the tlbx t clumn 2 in the first rw Duble-click the image and the Image URL windw appears Click Brwse Select UO_Lg_Wide.jpg and click OK In the URL, remve everything befre /samples This creates a relative URL s when the reprt is prmted frm Test t Prd the lg remains in place. In Prperties > Psitining > Size & Overflw, set the height t 50 px Select the cell and center Clumn 3 Empty Placehlder t Center Page Select clumn 3 in rw 1 and in Prperties > Psitining > Size & Overflw, set the width t 33% Reprt Name + Help Select rw 2 and in Prperties > Psitining > Size & Overflw, set the height t 50 px Set vertical alignment t bttm and center Drag a text item int rw 2 and type the riginal reprt name fllwed by Help Fnt: Arial, 14 pt, bld Versin 3.1 Page 18 f 21 January 6, 2015
Reprt Definitin Select rw 3 and in Prperties > Psitining > Size & Overflw, set the height t 50 px Drag a text item int rw 3 and type Reprt Definitin Fnt: Arial, 12 pt, bld HTML Item fr Help Cntent Using an HTML Item allws fr enhanced frmatting and bulleted items. Drag an HTML Item bject frm the tlbx t rw 4 Paste r type the help text Add If yu have questins r prblems with this reprt, please cntact the IDR team by email: idr@ithelp.uregn.edu Cmments Page Enterprise reprts can have a shelf life f many years. Other Advanced Reprt Writers may need t update r revise the reprt ver time s it is imprtant t dcument. A Cmments Page shuld be created fr all Enterprise reprts. This page will never render s nly Advanced Reprt Writers in Reprt Studi can see it. The purpse is t list reprt creatr/ develper cmments and recrd updates and mdificatins s a histry f reprt develpment is available fr future trubleshting and additinal develpment. This is an example cmments page frm the Budget Status Organizatin Drill-Thrugh reprt: Versin 3.1 Page 19 f 21 January 6, 2015
T create a Cmments Page: Navigate t Reprt Pages using the Page Explrer bar Drag a new page frm the Tlbx int the Reprt Pages pane Change the name t Cmments Page in the prperties table S that the Cmments Page des nt shw when the reprt is run: click n the ellipsis in the Render Variable in the prperties table fr Cmments Page Chse <New Blean Variable> in the variable drp dwn Name the variable Cmments Page and click OK The Reprt Expressin dialg bx will pen. In the Expressin Definitin bx type 1 = 2. Why? Since 1 can never equal 2, this expressin returns False. Cgns will nt render an bject with Blean expressin returning False. Click OK twice Duble click Cmments Page t pen it. Drag a table int the page and set it t 4 clumns and 2 rws. Set the first tw clumns t 100 px using Size & Overflw. Set the third clumn t 200 px. The furth clumn will fill the rest f the width. Add text bxes t the cells and labels t the tp rw: Versin, Date, Name/Phne and Cmments. Add text bxes in the ther rw and enter infrmatin. Drill-Thrugh Links Drill-thrugh hyperlinks can be set t nt display in Excel and PDF with render variables. Open the target reprt in a new windw when it is apprpriate fr the reprt. Versin 3.1 Page 20 f 21 January 6, 2015
Always display the drill-thrugh value in the headers f the target reprt t retain the cntext f the data. Fr instance, if the user clicks Fund t drill-thrugh then include Fund in the header. Graphs The UO default fr pie charts is Pie with 3D effects and Flat Bevel. If yu d nt see this style in the chart selectins, g t Tls menu >> Optins and in the Advanced tab and uncheck Use legacy chart authring. View as PDF View the reprt as PDF t catch any frmatting issues. Reprt rientatin can be set t landscape fr PDF. File menu >> PDF Page Setup >> Landscape Any drill-thrugh links must be set t display the nrmal field, nt the hyperlinked drill-thrugh field. When users select a drill-thrugh link in the PDF then Cgns encunters errrs. View as Excel View the reprt as Excel t catch any frmatting issues. Any drill-thrugh links must be set t display the nrmal field, nt the hyperlinked drill-thrugh field. Transactin Detail ffers a raw data view fr Excel with the headers placed in the main table s users can have a flattened ut versin f all data displayed in the reprt, use aut-filter r ther Excel features. This is accmplished with a drill-thrugh t anther reprt which is designed as a single table with n headers r fters. The Excel link is placed in the right side f the main reprt header. Versining Every reprt published t the Enterprise flders will be given a versin number. This versin number will be reflected in the fter with a mnth/year. Example: Versin 2.1-1/13 Questins? Cntact Integrated Data and Reprting Please cntact idr@ithelp.uregn.edu with questins. Prvide as much infrmatin as yu can, including a screensht if an errr is displayed, s we can help yu as efficiently as pssible. Versin 3.1 Page 21 f 21 January 6, 2015