BI Publisher TEMPLATE Tutorial

Transcription

1 PepleSft Campus Slutins 9.0 BI Publisher TEMPLATE Tutrial Lessn T2 Create, Frmat and View a Simple Reprt Using an Existing Query with Real Data This tutrial assumes that yu have cmpleted BI Publisher Tutrial: Lessn T1 Create, Frmat and View a Simple Reprt Using an Existing Query have at minimum BIP Pwer User security are familiar with PS Query (yu d nt have t create a query fr this Lessn) have dwnladed the BI Publisher Design Helper If yu are nt directly registering the Data Surce, the steps are as shwn here. IMPORTANT: Yu must use the SFIS TEST Database t cmplete this exercise. The PepleSft elements (e.g. Data Surce and Reprt Definitin) must nt be created in Prductin, nly in TEST. Click here t pen the page cntaining the link t the SFIS TEST LOGIN: SFIS QUICK LINKS/ LOGIN Using Real Data In Yur Template As yu learned in Lessn T1, the majr steps f the BI Publisher prcess fall int the general areas f Design Time and Run Time. In this lessn yu will generally fllw thse same steps, but nt in the same rder. There will be differences in what the Template prcess will lk like. Yu will be intrduced t sme ideas that will aid yu by saving time and effrt when wrking with yur templates and help yu prduce better lking reprts. Real Data Cmpared t Sample Data Yu will recall that, after yu reviewed the PS Query data surce, yu dwnladed a sample XML data file based n that Query using Reprt Definitin. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 1 f 21

2 PepleSft Campus Slutins 9.0 When yu wrked n yur template in MS Wrd, this sample XML data file was the file laded in frm the Add-ins menu. Oracle Definitin f Sample Data File: The sample data file is an XML file with sample data that is used fr data mapping, template preview, and determining burst fields. Preview actin is available within a desktp template designer r frm within the reprt definitin page. Fr PS Query and Cnnected Query data surce types the sample data file can be system-generated r upladed. Fr XML file data surce type, the sample data file must be upladed. Preview using Sample Data When yu ran Preview while wrking in the Template with sample data, the Preview lked like this: Preview using Real Data rather than Sample Data Once frmatted, when yu run the Preview with real data, the Preview lks like this: BIP TEMPLATE Tutrial - Lessn T2.dcx Page 2 f 21

3 PepleSft Campus Slutins 9.0 Imprtant: Keep in mind that this is real data, nt live data. This is the utput f a query as it existed at the pint in time that the query was dwnladed t an XML file. It will nt cntain live data unless the query has been registered as the Data Surce in PepleSft and wn t appear in its final frm until the Template and Reprt Definitin are linked. Outline f Majr Steps Using Real Data The steps fr wrking with real data rather than sample data are in the fllwing rder. Yu ll see that the step t dwnlad the Query data surce as an XML File thrugh Reprt Definitin ccurs after the Template is edited and befre the Reprt is published. That is, yu d nt need t dwnlad the Data Surce until yu want t test the reprt nline, via PepleSft. 1. Design: Data Surce a. Mck Up Reprt (Offline) b. Identify Data Surce PepleSft Query - Identify and review the query, nt create 2. Design: Template and Reprt a. Dwnlad Real data (XML File) b. Create BI Publisher Reprt Template (Offline) c. Preview and Tweak until Cmplete (Offline) d. Set up Reprt Definitin Assciate Data Surce and Template 3. Run Time: Request and View a. Publish BI Publisher Reprt b. View/Pst in Reprt Manager (nt shwn in this lessn See Lessn T1) BIP TEMPLATE Tutrial - Lessn T2.dcx Page 3 f 21

4 PepleSft Campus Slutins 9.0 1a Design: Data Surce Mck Up Reprt (Offline) One f the advantages f wrking with real data is that yu can d a lt f yur mcking up directly in the Template since yu are pretty much previewing hw the ultimate reprt will lk. This will be explained in mre detail belw. 1b Design: Data Surce Identify Data Surce PepleSft Query PEOPLESOFT TEST: Search fr and pen an existing Public Query in the SFIS PepleSft TEST Database The Query is named: WES_SFIS_TRAIN_BIP_COUNTRY_T2 Run and review the query t familiarize yurself with the cntents. D nt make any changes t this query. It cntains these fields: The cuntries are srted alphabetically by the Letter field and the Descr field. The first few rws f the Query shuld lk like this: BIP TEMPLATE Tutrial - Lessn T2.dcx Page 4 f 21

5 PepleSft Campus Slutins 9.0 After reviewing the Query, yu can clse it. Next yu will dwnlad the real data. 2a Design: Dwnlad Real Data (XML File) There are tw ways f creating the real data XML file frm PepleSft Query: 1. If yu are editing an existing Query r creating a new query, nce it s saved, d the fllwing: Run the Query. Using the link named Dwnlad t XML, dwnlad and save the XML file t the directry where yu have stred similar files. This wuld be the directry where yu will stre the template file, fr example. A menu such as this will pp up. It may differ depending upn which brwser yu are using. Save this XML file with a different name that indicates it cntains real data and add yur initials. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 5 f 21

6 PepleSft Campus Slutins 9.0 Fr example, in this demnstratin, the real data XML file is saved as: WES_SFIS_TRAIN_BIP_COUNTRY_T2_REAL_DATA_AAA.xml 2. If the riginal Query is nt pen and it s ready t be dwnladed, yu can save it as an XML file frm the Query Manager page list f queries by clicking n the link XML in the clumn headed Run t XML: As shwn abve, when the menu pens, yu can Save and/r Open the file in the directry where related files are lcated. Yu can pen the real data XML file t take a lk at it. The first few lines shuld resemble this: This XML file cntains the current utput f the Query as f the time yu saved the XML file. Yu ll see that the cntents f the fields at that time - appear here, e.g. A, Afghanistan, AFG, AF and s n. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 6 f 21

7 PepleSft Campus Slutins 9.0 2b Create BI Publisher Reprt Template (Offline) Once the real data XML file has been saved, pen MS Wrd t create a new dcument. A blank Wrd dcument pens. Yu will nw be able t lad the real data XML file t use as the basis fr the Template yu are creating with Wrd. If yu wish, yu can save the dcument at this pint as an RTF file, r yu can wait until later. Whether nw r later, keep in mind that yu must save the RTF file befre yu can run Preview. Select Add-Ins frm the menu. T gain access t the data in the real data XML file, click n the Data menu and select Lad XML Data Windws Explrer pens. Navigate t the directry where yu saved the XML file Click t pen the real data file. In this example, it is: WES_SFIS_TRAIN_BIP_COUNTRY_T2_REAL_DATA_AAA.xml BIP TEMPLATE Tutrial - Lessn T2.dcx Page 7 f 21

8 PepleSft Campus Slutins 9.0 When this message appears, click OK. T begin inserting the fields and frmatting the template, click n Insert. The Insert menu appears as fllws: Fr this example, the methd t insert the fields int the Template will be Table/Frm, the third ptin. Select Table/Frm. Belw are the three main sectins that make up Table/Frm dialg: Data Surce, Template and Prperties. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 8 f 21

9 PepleSft Campus Slutins 9.0 Yu will be selecting the desired fields frm the left sectin (Data Surce) and placing them in the middle sectin (Template). The fields are displayed in the first sectin as a tree. Click n Rw under Data Surce, and drag the cursr t the middle sectin under Template. When yu release the buttn, the fllwing pp-up dialg bx pens This bx appears when yu drag an element with children (ther elements belw the element), i.e. the fields belw Rw. The first tw sectins (Data Surce and Template) will lk like this: BIP TEMPLATE Tutrial - Lessn T2.dcx Page 9 f 21

10 PepleSft Campus Slutins 9.0 Click n the pp-up dialg, selecting Drp All Ndes. The tree starting with Rw nw appears in the middle, Template, sectin. Nte: A Nde is a term used in tree views fr an element in the tree view. The Data Surce and Template sectins nw lk like this: BIP TEMPLATE Tutrial - Lessn T2.dcx Page 10 f 21

11 PepleSft Campus Slutins 9.0 On the reprt we nly want t shw the fields Expr5_5, Descr, Cuntry, Cuntry 2char and Eu Member State. In rder t d that, yu either: drag and back t the left sectin, r right click and click Delete The Template sectin nw lks like this: Belw is an example f the Template, Prperties and Preview sectins when yu click n Rw in the Template sectin. The rder in which the data elements are shwn reflects the rder f the clumns in the table. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 11 f 21

12 PepleSft Campus Slutins 9.0 Yu can bserve attributes f any f the fields under the Prperties sectin by clicking n the individual fields in the Template sectin. Fr definitins f the Prperties terms, ne surce is BI Publisher Template Builder fr Wrd Tutrial Anntated (see page 9 the text highlighted in yellw). If yu were t click OK at this pint, the template wuld be a simple list f rws resembling the table in the Preview panel under Prperties. In rder t frmat the fields as desired, yu need t grup the rws as described here: T grup each alphabetical set f cuntries by a letter (Expr5_5): Select the nde Rw under Template. Under Prperties Set Style t FreeFrm (i.e., change it frm Table. Set Gruping t EXPR5_5 in the Prperties sectin. Srt by will change t EXPR5_5. Leave as is. The Template, Prperties and Preview sectins will nw lk like this: BIP TEMPLATE Tutrial - Lessn T2.dcx Page 12 f 21

13 PepleSft Campus Slutins 9.0 Click n Expr5 5 under Template. Yu ll bserve that the Prperties Style is Table. Leave as is. Yu d nt need t make any mre changes. The data starting with F DESCR and ending with EU_MEMBER_STATE E cmprise a repeating sectin. T apply these changes, click OK. The template will nw display n the page and lk like this: BIP TEMPLATE Tutrial - Lessn T2.dcx Page 13 f 21

14 PepleSft Campus Slutins 9.0 2c Preview and Tweak Until Cmplete (Offline) T get a preliminary view f the reprt, run a Preview at this time. Click n Add-Ins > Preview and select PDF. If yu haven t saved the file as an RTF yet, since this is the first time yu re running a Preview, yu will receive the message prmpting yu t save the file as an RTF. In this example, the file is named WES_COUNTRY_T2_AAA.rtf. Once yu save the RTF file, the first part f the table will appear as fllws, displaying real data: BIP TEMPLATE Tutrial - Lessn T2.dcx Page 14 f 21

15 PepleSft Campus Slutins 9.0 T get sme ideas n hw t finish frmatting the reprt, refer t the applicable instructins in Lessn T1. Nte that with the real data shwing in the Preview clumns, yu have a better indicatin f hw t adjust the widths. T differentiate this reprt frm the Lessn T1 reprt, yu culd change sme f the clrs in the Cnditinal Frmatting, change the fter, change the spacing, and edit the heading. Fr this demnstratin, the heading will be changed t: BI Publisher Template Example T2 List f Cuntries with Cdes EU Members Highlighted Keep running and viewing the Preview as yu make yur changes. Here is hw the tp sectin f this Example reprt lks with the new frmatting and real data: If yu re satisfied with the frmatting f the reprt, save the RTF file. Yu can nw prceed with the next steps. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 15 f 21

16 PepleSft Campus Slutins 9.0 2d Set Up Reprt Definitin Assciate Data Surce and Template Next we need t create a new XML file, ne that will be cnnected with the PS Query. The existing XML file, WES_SFIS_TRAIN_BIP_COUNTRY_T2_REAL_DATA_AAA, cntains real data, frm the pint in time that the XML file was dwnladed. The real data XML File is nt cnnected t the data in PepleSft. When the new XML file is dwnladed and published in cnjunctin with the BI Publisher Template, each time it is published, it will display the up-t-date data currently in PepleSft. This is dne thrugh creating a Reprt Definitin t assciate the Query data surce and Template by Dwnlading the Data Surce frm PepleSft (Query), and Uplading the recently saved Template Navigate t Reprt Definitin: (Reprting Tls > BI Publisher > Reprt Definitin) Click n Add a New Value. Enter a new Reprt Name. Data Surce Type: The default is set t PS Query. Data Surce ID: Search fr and enter the Query name (in this example, WES_SFIS_TRAIN_BIP_COUNTRY_T2). Click the Add buttn. The Reprt Definitin pages will pen. Fill in r bserve the fllwing fields n the Definitin page: BIP TEMPLATE Tutrial - Lessn T2.dcx Page 16 f 21

17 PepleSft Campus Slutins 9.0 Next we dwnlad the Query data by clicking n the Sample Data link at the bttm f the page. The fllwing menu will pp up. Save the file, with the name shwn, t the directry wherein yu stre yur RTF file. D nt change the name f the file. D nt change the extensin f XML. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 17 f 21

18 PepleSft Campus Slutins 9.0 In rder t save the Reprt Definitin, yu must first assciate the Template with it. Click n the Template tab. Fill in r bserve the fllwing fields n the Template page: Uplad the RTF Template by clicking n the yellw Uplad buttn. A ppup menu will appear prmpting yu t brwse fr the RTF Template file yu recently created. Click n the Brwse buttn and navigate t the lcatin f the file. After yu brwse and lcate the RTF Template file, click n the yellw Uplad buttn t uplad the file. Once yu have upladed the RTF Template file, yu will see the fllwing at the bttm f the Template page, in the Template Files sectin. The Template File name f WES_COUNTRY_T2_AAA.rtf is listed. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 18 f 21

19 PepleSft Campus Slutins 9.0 By clicking n the yellw Preview buttn, yu can run a Preview at this pint, which will be similar t the PDF previews yu saw befre, i.e. it will cntain sample data and it will nt display the Cnditinal Frmatting that yu created. The beginning f the preview file wuld resemble this: Clse the Preview. Click n the Output tab. Change the Default t RTF. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 19 f 21

20 PepleSft Campus Slutins 9.0 D nt make any ther changes n the Output page. Save the Reprt Definitin by clicking n the Save buttn in the lwer left. Nw that this step has been cmpleted, yu can publish the reprt. 3a Run Time: Publish BI Publisher Reprt Query Reprt Viewer: Belw is ne f the methds fr publishing a BI Publisher Reprt: Query Reprt Viewer. The secnd methd, using Query Reprt Scheduler and Query Manager is discussed in Lessn T1 under Sectin 3b Run Time: View/Pst in Reprt Manager. If yu are familiar with thse prcesses, yu can prceed with thse instructins as well. Navigate t the page - Reprting Tls > BI Publisher > Query Reprt Viewer On the Query Reprt Viewer page, enter the Reprt Name and click the Search buttn. The RTF file pens, and the page appears as fllws: Yu ll see that the Frmat is shwn as RTF which yu shuld leave as is. Click n the View Reprt link. Depending upn yur brwser, Save r Open the file. Save the RTF file with a unique name. The entire first page (1 f 9) resembles the fllwing. BIP TEMPLATE Tutrial - Lessn T2.dcx Page 20 f 21

21 PepleSft Campus Slutins 9.0 This cncludes Tutrial T2 BIP TEMPLATE Tutrial - Lessn T2.dcx Page 21 f 21