Creating RTF Templates by Using BI Publisher 11g Template Builder for Word

5/10/2015 CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm 1/44

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

PurposeThistutorialcovershowtouseOracleBusinessIntelligencePublisherTemplateBuilderforMSWordtocreateRTFtemplates.

Youwilllearnhowto:

LogontoBIPublisherServerandcreateRTFtemplatesinOnlinemodeUsetheSampleXML/XMLschematocreateRTFtemplatesinOfflinemodeCreatetabularreportsCreatechartsandpivottablesInsertfieldsandrepeatinggroupsUsenativeMSWordformattingUsetoolstovalidatetemplates,browsefields,andcheckaccessibility

TimetoCompleteApproximately2hours.

OverviewTemplateBuilderisanextensiontoMSWord(2003orlater)thatsimplifiesRTFtemplatecreationforOracleBIPublisherreports.

RichTextFormat(RTF)isaspecificationusedbycommonwordprocessingapplications,suchasMSWord.TemplateBuilderprovideseasytousewizardsforinsertingfields,tables,forms,charts,andcrosstabs.Also,TemplateBuilderprovidestranslationfeaturesandenablesyoutopreviewreportsbyusingthetemplateinsupportedformats.

ThistutorialprovidesstepbystepprocedurestouseTemplateBuildertocreateRTFtemplatesforOracleBIPublisherreports.TheexampleswillcovercomplexformattingandprocessingofreportsbyusingtheseRTFtemplates.YouwillalsolearnhowtoworkinbothOnlineandOfflinemodes.TranslatingtheRTFtemplatesiscoveredindetailintheothertutorial:ExploringAdvancedFeaturesofBIPublisher11g,andalsointheInstructorLedTraining(ILT)forBIPublisher11g.

PrerequisitesTocompletethistutorial,youshould:

DownloadtheMyTemplatesandFileszipfile,andunzipinafolderwiththesamename.CreateaLearnfolderonyourharddrive.HaveaccesstotheSamplesfilesavailableinthePublisherDesktopProgrammenu.YouwillbeusingsomeofthereportsthataresimilartotheonesyoucreatedintheOBE'GettingStartedwithOracleBusinessIntelligencePublisher'.ThesereportsareprovidedtoyouintheMyTemplatesandFileszipfile.CompletetheGettingStartedwithOracleBusinessIntelligencePublisherOBEmentionedabove.Installtherequiredsoftware.

TheassumptionthroughoutthiscourseisthatyouarefamiliarwiththebasicuserinterfaceandnavigationoftheOracleBIPublisher.

SoftwareRequirementsThefollowingisalistofsoftwarerequirements:

MicrosoftWord(2003or2007)JavaSEDevelopmentKit(JDK)5orlater(ThisalsoincludesJavaRuntimeEnvironment[JRE].JRE1.6orlaterisrequired.)MS.NETFramework3.5withSP1orlater.OracleBIEE11ginstalledonamachinethatTemplateBuildercanconnecttobyusingHTTP.OracleBIEE11gshouldbeabletoconnecttoasupporteddatasource.

InstallingTemplateBuilderandExploringtheTemplateBuilderUserInterfaceInthistopic,youwillseehowtodownloadtheTemplateBuilderaddin,andinstallit.ThenyouwillexplorethetheTemplateBuilderuserinterface.

InstallingTemplateBuilder

TemplateBuildercanbedownloadedfromtheGetStartedregionoftheOracleBIPublisherHomepageorOracleBIEEHomepage.Inthistopic,youwilldownloadtheTemplateBuilderaddinandinstallit.
http://apex.oracle.com/pls/apex/f?p=44785:24:0::NO:24:P24_CONTENT_ID,P24_PREV_PAGE:5081,2http://apex.oracle.com/pls/apex/f?p=44785:24:0::NO:24:P24_CONTENT_ID,P24_PREV_PAGE:5722,2http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/files/My%20Templates%20and%20Files.ziphttp://apex.oracle.com/pls/apex/f?p=44785:24:0::NO:24:P24_CONTENT_ID,P24_PREV_PAGE:5081,2



PerformthefollowingstepstodownloadandinstallTemplateBuilder:

1. LogintoOracleBIPublisher.

2. IntheGetStartedsectionoftheHomepage,clicktheDownloadBIPublisherToolsmenu,andselectTemplateBuilderforWord.

3. TheOpeningBIPublisherDesktop.exedialogboxopens.ClickSaveFile.Savethefiletoasuitablelocationonyourharddrive.



4. NavigatetothelocationwhereyouhavedownloadedtheBIPublisherDesktop.exefileanddoubleclicktheexecutablefiletobegintheinstallation.

5. a.AftertheInstallShieldwizardstarts,followtheonscreeninstructionstocompletetheinstallation.

b.ClickFinish.



PrintPreview

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWordThistutorialcontainsthefollowingsections:

PurposeTimetoCompleteOverviewPrerequisitesSoftwareRequirements

6. IfTemplateBuilderisinstalledcorrectly,youwillseetheBIPublisherribboninWord2007:

Note:IfyouareusingMicrosoftWord2007youmayneedtomodifyyourAddInsettings:Todoso,clicktheOfficebutton,clickWordOptions,andthenclickAddIns.

ExploringtheTemplateBuilderUserInterface

Inthistopic,youwillreviewTemplateBuilderUIcomponents.YouwillopentheexistingBalanceletter.rtffile.

(ThisfileismadeavailabletoyouintheMyTemplatesandFileszipfile,aswellasinSampleafteryouinstalltheTemplateBuilder.)

1. TheBIPublisherribbonhasthefollowingoptions:

Online

YoucanlogintoBIPublisherfromhere.Afteryoulogin,youcanusetheOpenbuttontoopenareporttheBIPublishercatalog.

LoadData

ThisgroupofcommandsenablesyoutoloadasavedsampledatafileorsampleschematoTemplateBuilder.YoumustloaddatatousemostoftheTemplateBuilderfunctionality.TheSampleXMLbuttonallowsyoutoloadasampleXMLfilethatcontainsallthefieldsthatyouwanttoinsertintoyourtemplateasadatasource.youarenotconnectedtotheBIPublisherserver,usethismethodtoloadyourdata.

Insert

ThisgroupenablesyoutoinsertthefollowingelementsintoyourRTFtemplate.

TableWizard:Thisfunctionprovidesawizardthatguidesyouthroughthecreationoftablesusedintypicalreports.
http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htmhttp://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/files/My%20Templates%20and%20Files.zip



InstallingTemplateBuilderandExploringtheTemplateBuilderUserInterfaceBuildinganRTFTemplateinOfflineModeBuildinganRTFTemplateinOnlineModeWorkingwithaPivotTableinanExistingRTFTemplateUsingTemplateBuilderUtilities:FieldBrowser,ValidateTemplate,andCheckAccessibilitySettingConfigurationOptionsforTemplateBuilderSummaryResources

ViewingScreenshots

Clickicontohideall

screenshots

Note:Alternatively,youcanclickanindividualicon(orimage)associatedwitheachsteptoview(orhide)thescreenshotassociatedwiththatstep.

PivotTable:Usingthisyoucandraganddropdataelementsintoapivottable.

Chart:BIPublisherdoesnotrecognizenativeMicrosoftWordcharts.TheInsertChartfunctionallowsyoutoinsertachartthatisunderstoodbyOracleBIPublisher.

ab|Field:Thisfunctionallowsyoutoselectfieldsfromyourdatasourceandinsertthemintoyourtemplate

Table/Form:Usethisfunctiontoinsertdatafieldstobeorganizedasasimpleornestedtableorasaformthatisrepeatedwithdifferentdata.Youmayevenorganizeallthedatafieldsforthewholedocumentbeforeinsertingthem.

RepeatingGroup:Usethistoselectordefineagroupofelementstoberepeatedforeachoccurrenceofanelementinthedata.

ConditionalFormat:Thisenablesyoutodefinesimpleconditionalformatstoapplytotablerowsorcells.

ConditionalRegion:Thisenablesyoutoinsertaconditionalstatementaroundaregionofthetemplate.Aconditionalregionisanareathatissurroundedbyaconditionalstatement.Ifthestatementteststrue,theareaisdisplayedinthereportiftheconditiontestsfalse,theareaissuppressedfromthereport.

AllFields:ThisfunctioninsertsallfieldsfoundintheXMLdataintoyourdocument.Itwillalsoinsertprocessinginstructionsintoyourdocumentthatwillrepeatasection,suchasatablerowwhentheassociatedXMLelementisrepeated.Whenyouareworkingonadeeplynestedhierarchyofelements,itisbettertoinsertelementsseparately,insteadofinsertingallfields.

Preview

ThisenablesyoutopreviewyourRTFtemplatewithsampleXMLdata.ThepreviewmenuoffersyouPDF,HTML,RTF,PowerPoint,Excel(MHTMLformat),andEXCEL2000asoutputformats.Whenyouselectanyoftheseoutputformats,TemplateBuilderwillmergethedataintoyourtemplateandcreatetheoutputdocument.

Tools

Thisgrouphasthefollowingadvancededitingtoolsforthetemplates:FieldBrowser:ThisisforadvanceduserstoreviewandeditBIPublishercommandsinsertedintheformfields.Itshowsthecommandsbehindeachformfieldandallowsyoutoeditthem.UsethistooltocorrectflawedRTFtemplatesortoupdatemultiplefieldsefficiently.ValidateTemplate:ThevalidationfunctionchecksthetemplateforincorrectuseofBIPublishercommandsandunsupportedelementsintheWordfile.CheckAccessibility:Runthistooltocheckfortheaccessibilityfeaturesinthetemplate.Translation:ExtractText:ThiscommandenablesyoutocreateastandardXLIFFtranslationfilecontainingtheboilerplatetextfromyourtemplate.XLIFFisastandardfileformatthatisunderstoodbymanytranslationsoftwarepackages.BecauseanXLIFFisanXMLfile,youcantranslatethetextinatexteditor.PreviewTranslation:ThiscommandenablesyoutopreviewyourtemplateasaPDFfileusingaspecifiedXLIFFtranslationfile.Thisfunctionalityenablesyoutotesttranslationfiles.LocalizeTemplate:ThiscommandappliesatranslationfiletoanRTFtemplate.ThismeansthatinyourcurrentRTFtemplateallboilerplatetextistranslated.Themainfunctionofthisfeatureistocreatealanguagespecificversionofatemplate.ExportXSLFOStylesheet:ThisfunctionallowsyouconverttheRTFtemplateintoanenhancedXSLFOstylesheet.ThisfunctioncanbeusedtogenerateXSLFOfordebuggingorfurthercustomization.FOFormattedXML:ThisfunctionallowsyoutoapplytheXSLFOstylesheetgeneratedfromtheWorddocumenttothesampledataandsavetheintermediateFOformat.Thisfunctionismainlyfordebugging.PDFThisfunctionconvertstheWorddocumenttoPDF.

Options

ThisgroupallowsyoutochangethefollowingoptionsthatinfluencethelookandfeelofTemplateBuilder:DisplayModePreviewBuild

Youwilluseallthesefunctionsinthecomingsections.



BuildinganRTFTemplateinOfflineModeRichTextFormat(RTF)isaspecificationusedbycommonwordprocessingapplications,suchasMicrosoftWord.WhenyousaveatemplateinTemplateBuilder,thefiletypeshouldbeRTF.YoucanbuildanduploadyourtemplateviaadirectconnectionwiththeBIPublisherServer,calledOnlinemode,oryoucanbuildanduploadyourtemplateinadisconnectedmode,andiscalledOfflinemode.

Note:Toworkindisconnectedmode,youmusthaveasampledatafileavailableinyourlocalworkenvironment.Inthisexample,thesampledatafileisBalance.XML.

1. a.SelectStart>Programs>OracleBIPDesktop>Samples>RTFTemplates.

b.OpentheBalanceLetterfolderandloadthefileBalanceLetterStart.rtf.Thisisasampletemplatefile.

2. TheRTFtemplatefileopensinMSWord.

3. Tobuildareportandviewthereportwithdata,youmustloadsampleXMLdata.WhenworkingindisconnectedorOfflinemode,youmusthavesampledatastoredlocally.

a.ClickSampleXMLintheLoadDatagroup.



b.SelecttheBalance.xmlsampledatafilelocatedunderyourlocaldrive(C):\ProgramFiles\Oracle\BIPublisher\BIPublisherDesktop\samples\RTFtemplates\BalanceLetter.ClickOpen.

Youwillseeaconfirmationmessagethatthedataisloadedsuccessfully.

4. a.NowinsertthevariousfieldsintheBalanceLetterbyreplacingtheplaceholders.Selecttheplaceholder,andclickab|Field,intheInsertgroup.

b.IntheFielddialogbox,selecttheCustomerNamefieldandclickInsert.



5. TheCustomer_NamefieldappearsintheBalanceLetter.ClickthespacefollowingtheCUSTOMER_NAMEandpressEnter.Thisaddsalinebreak.

6. Repeatthisprocess,addingAddressLine1.Also,addCity,State,andZip,eachofthemseparatedbyacommaandspace.Thelettershouldlooklikethis:



7. a.Insertthefollowingfieldsintotheletter,intheappropriateplaceholders:

As_Of_DateTrxCurrencyCodeCInvOpenBalance.

NotethatyoumayhavetoscrollintheFielddialogboxtolocatethesefields.

b.ClosetheFieldDialogbox.

8. IncludethetableofinvoicesbyusingtheTableWizard.TheTableWizardallowsyoutoaddtables,forms,charts,andotherobjects.

a.Selecttheplaceholderintheformletter.ClickTableWizardinthegroup.



TheTableWizardopens.

b.Acceptthedefault(Table)andclickNext.

9. TheTableWizardintuitivelyselectsthecorrectdatasetforyou.Inthisexample,itis/ARXCOBLX/G_CUSTOMER/G_CURRENCY/G_INVOICES.AcceptthedefaultandclickNext.



Youcanchangethis,however,byclickingthedropdownlist.

10. a.Selectthefollowingcolumns:

TrxNumberTransactionDateTransAmountTransAmount(Second"TransAmount"isTransAmountRemaining)

Usetheshuttleicons tomoveitemstotheselectedcolumnoneatatimeorusethedoubleheadedshuttleiconstomoveallcolumnsatonce.

Usetheresequenceicons tomovethecolumnsupanddown.

b.ClickNext.

11. Youcangroupyourdata.YouusetheBreakoptiontoinserteitherapagebreakorsectionbreakaftereachoccurrenceofagroup.Inthisexampleyouwillnotselectanyoptions.ClickNext.



12. a.Selectasortsequenceandindicatethetypeofdatathatisbeingsorted.SelectTransactionDate,indicatethatthisfieldisanumber,andsortthecolumnindescendingorder.

b.ClickFinish.

13. Thetableopensinthetemplate.ObservethecodesF(for"Grouping")andE(for"Each")inthetable.



14. PreviewthistemplateinPDFformat.InthePreviewgroup,clickPDF.

ThereportisdisplayedwiththeXMLfiledatathatyouloadedearlier.



15. YoucanviewtheWordpropertiesofanytablefieldthatyouhaveaddedtoyourtemplate.DoubleclickTRANS_AMOUNTinthetable.

TheBIPublisherPropertiesdialogboxisdisplayed.

ClicktheWordPropertiesbuttontoedittheinsertedfields.

16. a.IntheTextFormFieldOptionsdialogbox,selectNumberfromtheTypedropdownlist.

b.Setthedefaultnumberandnumberformat.Enter$1,000.00intheDefaultnumbertextboxandselect$#,##0.00fromtheNumberformatdropdownlist.



c.ClickOK.Thetemplateisdisplayedwiththeappliedformatting.

d.RightjustifythisTransAmountfieldbyusingMSWordParagraphmenu.

17. Youcanformattheotherfieldsasperyourrequirement.However,becausethedateisatextfieldinthisexample,youwillnotbeabletoformatit.

YoucanalsoformatthecolumnnamesofthetabletoameaningfuldisplayusingtheMSWordmenu.ChangethecolumnnamesasgivenbelowandthenkeeptheformattingasBold.

TrxNumbertoInvoiceNumberTransactionDatetoDateTransAmounttoTransactionAmountTransAmountRemainingtoTransactionAmountRemaining

18. SavethetemplateasMyBalanceLetterintheLearnfolderonyourlocaldrive.



19. Whenyoupreviewthistemplate,thereportisdisplayedwiththeappliedformatting.

20. Closethepreviewandthetemplatefile.

21. LogintoBIPublisherEnterpriseEdition.



22. OntheCatalogpage,navigatetotheBalanceLetterreportandclickEdit.ThisBalanceLetterreportispartoftheSamplesfiles.

23. TheReportEditoropens.ClickAddNewLayout.



24. ClickUpload.

25. a.EnterBalanceLetterasthelayoutname.

b.ClickBrowse.NavigatetoandselectMyBalanceLetter.rtffromtheLearnfolder,andclickOpen.

c.SelectRTFTemplateasthetypeandEnglish(UnitedStates)asthelocale.

.

d.ClickUpload.

26. Theuploadedlayoutisdisplayedinthelayouteditor.ClickSave.



27. ClickViewReport.

Inthedisplayedreport,clicktheBalanceReporttab.ThereportbasedonthetemplatethatyouhavedesignedinTemplateBuilderisdisplayed.



ThisconcludesthetopiconcreatingaRTFtemplateusingTemplateBuilderinOfflinemode.

BuildinganRTFTemplateinOnlineModeThistopicdemonstrateshowtodesignanRTFtemplatewhileloggedintoBIPublisher.YouwilllogintoBIPublisherthroughTemplateBuilder,defineanRTFtemplate,addatablewitharunningtotal,addgroupingandsorting,addapagebreak,addachart,previewdatainthereportbyusingthetemplate,uploadtheRTFtemplatetoBIPublisherEnterpriseServer,andviewthereportonBIPublisherEnterpriseServer.

1. a.Openanewblankworddocument.

b.LogintoBIPublisherbyclickingLogOnintheOnlinegroup.

c.EntertheReportServerURLastheBIPublisherServerinstalledonyourmachine.Forexample,http://:/xmlpserver



d.ClickLogin.

2. TheOpenTemplatedialogboxopens.SelecttheSalaryReportsNoParametersreport.(Navigateto\SharedFolders\SampleLite\PublishedReporting\Reports\)

3. Whenthereportopens,youwillnotseeanydataintheblankMSWorddocument.However,XMLdatadefinitionsareloadedfromthereporttofacilitatethedefinitionofatemplate.NoticethatthereportnameappearsinthetitlebarofMSWordbesidethedocumentname.



4. Nowstartbuildingthetemplate.

Insertawordtablewithtworows.Insertthechartinthefirstrow,followedbythetableinthesecond.

5. Nowyouwilladdachartforthistemplate.Positionyourcursorinthefirstrowofthewordtable.IntheInsertgroup,clickChart.

6. TheChartwindowopens.SelectRowintheDatapane.



7. a.DragAnnualSalarytoValuesintheLayoutpane.b.DragDepartmentNametotheLabelstextbox.



8. IntheLayoutpane,selectthefollowinginformation:

Step Attribute Values

a. Type BarGraphVertical

b. Style Earth

c. Aggregation Average

f. Title:Title AverageAnnualSalarybyDepartment

TheChartwizardshouldlooklikethis:

ClickOK.



9. Thechartappearsinthetemplate.

10. NowusetheTablewizardtoinsertthetableinyourtemplate.Youdidthisintheprevioustopic,butinOfflinemode.TakeyourcursertothenextrowoftheMSWordtable,andtheninsertthetable.

a.SelectDepartmentName,Manager,Name,JobTitle,AnnualSalary,andFedWithheld(inthatorder).Yourselectionsshouldbelistedintherightpaneofthewizardpage.



b.ClickNext.

11. IntheHowwouldyouliketogroupyourreport?section,selectthefollowingoptions:

GroupByDepartmentNameGroupAboveBreakSectionThenByManagerGroupLeft

RecallthatwhileworkingonthetableintheOfflinemode,youdidnotchooseoptionsforgrouping.ThisexampleusessectionbreaksinthereportwithDepartmentNameasthegroupandhasasecondgroupingbyManagers.

ClickNext.

12. SortbyAnnualSalaryintheWhichfieldswouldyouliketousetosortthedata?section.ClickFinish.



13. Thistableappearsinthedocument,belowthechart.RightjustifythecellforANNUAL_SALARY.



14. SavethefileasManagerFinancialsReport.rtfinyourLearnfolder.

15. SelectthePDFpreviewoptionfromthePreviewgroup.ThePDFisdisplayed.ObservethatbecauseyouusedtheGroupaboveoptionwhileinsertingthetable,adepartmentnameappearsaboveeachtable.



16. ClosethePDF.

17. Now,uploadthetemplatetotheBIPublisherServer.

ClickUploadTemplateAsintheOnlinegroup.

18. Uploadasnewdialogboxopens.EnterManagerFinancialsReportastheTemplateName.

19. Aconfirmationmessageisdisplayed.ClickOK.



20. NavigatetotheSalaryReportNoParametersreportintheBIPublisherEnterpriseServerandclick

21. Theuploadedlayoutisdisplayedinthelayouteditor.SaveandthenclickViewReport.



22. Inthedisplayedreport,clicktheManagerFinancialsReporttab.ThereportbasedonthetemplateyouhavedesignedinTemplateBuilderisdisplayed.



Thisconcludes"BuildinganRTFTemplateinOnlineMode"topic.

WorkingwithaPivotTableinanExistingRTFTemplateThistopiccoversaddingapivottabletoanexistingRTFtemplate.YouwillopenanexistingRTFtemplatetopreviewachart,andaddapivottabletothetemplate.TheRTFtemplateRetailSales.rtfisstoredintheMyTemplatesandFileszipfile.

1. OpentheRetailSales.rtffileinMSWord.Thefilelookslikethis:

2. IntheBIPublisherribbon,clickSampleXMLintheLoadDatagroup.

3. NavigatetoandselectRetailSales.xml(locatedinthesamefolderastheRetailSalesRTFtemplate),andclickOpen.Thisfilecontainsretailsalesdatafromdifferentindustries.
http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/files/My%20Templates%20and%20Files.ziphttp://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/files/My%20Templates%20and%20Files.ziphttp://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/files/My%20Templates%20and%20Files.zip



4. ClickOKinthemessagedialogbox.Thedataisloaded.

5. ClickEntertwicetoenteralinebreakafterthePIEChart.

6. ClickPivotTableintheInsertgroup.ThePivotTabledialogboxopens.



YoudragdatacolumnsfromtheDatapanetotheblankLayoutpanetobuildapivottable.

7.a.DragYeartoColumn

b.DragMonthtoColumn

c.DragIndustrytoRow

d.DragSalestothePleasedropdataherearea.

8. a.SelectSalesintherow.

b.SelectthecelltotherightofFormatinthePropertiespanetoselectSUM.

c.Select#,##0inthepropertiesdropdownlist.



d.ClickOK.

9. Thepivottableappearsinthetemplate.



10. Savethetemplate,andthenclickPDFinthePreviewgrouptoviewyourpivottable.

Thisconcludesthe"WorkingwithaPivotTableinanExistingRTFTemplate"topic.

UsingTemplateBuilderUtilities:FieldBrowser,ValidateTemplate,andCheckAccessibilityThistopicwilldemonstratehowtousetheFieldBrowser,CheckAccessibility,andValidateTemplateutilitiesavailableinTemplateBuilder.YouwillusetheRetailSales.rtffile,whichismadeavailabletoyouatMyTemplatesandFileszipfile.

UsingValidateTemplate

1.a.OpentheRTFfileRetailSales.rtf.
http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/files/My%20Templates%20and%20Files.zip



b.IntheBIPublishertab,intheToolsgroup,clickValidateTemplate.

2.Iftherearenovalidationerrors,NoErrorfoundisreturned.

Ifanerrorisfound,theerrorwillbedisplayed.

Note:YoucanalsouseFieldBrowsertohelplocatetheerror.

UsingFieldBrowser

TheFieldBrowserutilityprovidesafastwaytoreviewandupdatetheBIPublisherinstructionshiddenintheMicrosoftWordformfields.Thisisparticularlyusefulforunderstandingandmodifyingexistingtemplates.



1. IntheBIPublishertab,intheToolsgroup,clickFieldBrowsertoopentheFieldBrowserdialogbox.

2. TheFieldBrowserdialogboxshowsthedefaulttextoftheformfieldintheTextcolumn,andtheinstructions(fromthehelpandstatustextoftheformfield)intheCodecolumn.

Note:

Whenyouselectaspecificrowinthedialogbox,thematchingformfieldwillbeselectedintheMicrosoftWorddocument.IfyouselectsomepartofthetextbeforeopeningtheFieldBrowser,thedialogshowsonlythefieldsinyourselection.Ifnotextisselected,FieldBrowserwillshowallfieldsinthedocument.Thisscreenshotshowsall



thefields,becausenospecificformfieldwasselectedbeforeopeningFieldBrowser.

3. YoucanupdateprocessinginstructionsdirectlyfromtheFieldBrowserdialogbox.

a.SelectINDUSTRYintheTextcolumn..

TheEditfieldshowstheprocessinginstructions.

b.ChangeallbutthefirstofthecapitallettersofthewordINDUSTRYtolowercase.Inotherwords,changeINDUSTRYtoIndustry.

c.SelectUpdate.



Observethatthecodeischangedasperyouredit.

Note:RecallfromtheprevioustopicthatyoucanuseFieldBrowsertofindoutvalidationerrorsinthetemplate.UsetheFindoptionintheFieldBrowsertosearchfortheerrors.

UsingCheckAccessibility

TemplateBuilderprovidesanaccessibilitycheckertocheckthetemplateforfeaturestoenhancetheaccessibilityofthereportforreportconsumerswhomayneedassistingtechnologiestoviewthereport.Formoreinformationaboutdevelopingaccessiblereports,see"DesigningAccessibleReports"intheOracleFusionMiddlewareReportDesigner'sGuideforOracleBusinessIntelligencePublisher.

1. IntheBIPublishertab,intheToolsgroup,clickCheckAccessibility.

2. Thetoolgeneratesareportindicatingareasofyourtemplatethatdonotincludetheaccessibilityfeatures.



Thistemplatedoesnothaveaccessibilitycompatibilityforarowheaderofatable.

Formoreinformationaboutdevelopingaccessiblereports,seeDesigningAccessibleReports"intheOracleFusionMiddlewareReportDesigner'sGuideforOracleBusinessIntelligencePublisher.

SettingConfigurationOptionsforTemplateBuilderInthistopic,youwillseehowtosetthevariousUIoptionsandconfigurationoptionsforTemplateBuilder.Theimportantsettingscoveredare:

TheUIOptionstaballowsyoutochangesomeoptionsthatinfluencethelookandfeelofTemplateBuilder.ThePreviewOptionstaballowsyoutospecifyoptionsthatinfluencethePreviewfunctionalityofTemplateBuilder.TheBuildOptionstaballowsyoutospecifyoptionsthatinfluencehowTemplateBuildergeneratestablesandforms.

SettingUIOptionsThetreeviewshowingthedatasourcecanshoweitherthecorrectXMLtagnamesofthedatasourceoraslightlymodifiedversionthatiseasiertoread.

SelecttheElementNamesforReportsXMLoptiontoshowthemodifiedlabels.Theselabelscontainnocharacters,usetitlecasecapitalizationandusespacesinsteadofunderscores.

SettingPreviewOptionsThePreviewtaballowsyoutospecifyoptionsthatinfluencethePreviewfunctionalityofTemplateBuilder.

Thevariousoptionsthatyoucansetusingthisdialogare:

StyleTemplateLocaleJavaHomeJavaOption



StyleTemplate

IfyouhaveaBIPublisherstyletemplateavailablelocallyyoucanspecifyithere.ThestyleinformationinthestyletemplateisappliedtoRTFlayoutsatruntimetoachieveaconsistentlookandfeelforyourenterprisereports.Inthisexamplenostyletemplateisdefined.

Formoreinformation,see"CreatingandImplementingStyleTemplates"intheOracleFusionMiddlewareReportDesigner'sGuideforOracleBusinessIntelligencePublisher.

Locale

Youcanchoosethelanguageandterritoryusedforpreviewingyourtemplate.Whilethischangewillnotautomaticallytranslateanyfiles,itisimportanttosetthecorrectlocaleforthepreviewtousethecorrectdirectionofthetext(lefttorightorrighttoleft),andtocorrectlysetlocalespecificdate,number,andcurrencyformats.InthisexampletheLocaleissettoEnglishUnitedStates[enUS]

JavaHome

ThePreview(andexportfunctionality)requiresJavacode.YoucanchangethepathtoyourJAVAHOMEdirectory.Ifthisoptionisnotspecified,TemplateBuilderassumesthattheJavavirtualmachine(java.exe)isaccessibleinthePATHspecifiedinyourenvironmentvariablesofWindows.InthisexampleitissetasC:\ProgramFiles\Java\jre6

JavaOption

SpecifythememorytoreserveforTemplateBuildertoprocessthetemplate.ThedefaultvalueisXmx256M.Theexampleshowsthesame.

SettingBuildOptions

UsetheBuildtabtospecifyoptionsthatinfluencehowTemplateBuildergeneratestablesandforms.

ThevariousBuildoptionsthatyoucansethereare:

ForeachformfieldFormfieldsizeTableHeaderColor



Foreachformfield

UsethistochoosehowtheTemplateBuildercreatestheformfieldsforprocessinginstructionsintheInsertTable/Formdialogbox.TheDescriptiveoption(forexample:foreachInvoice)rendersadescriptiveformfieldfortheprocessinginstructions.Thisoptionmakesthelayouttemplateeasiertounderstand.However,thelongerfieldsmaydistractfromthevisuallayoutofthetemplate.TheAbbreviatedoption(forexample:F)providesaoneletterabbreviationforeachinstruction.

SelecttheHiddenoptiontogeneratetheprocessinginstructionformfieldsusingMicrosoftWord'shiddenfonteffect.Hiddentextishiddenintheprintpreview.YoucandisplayorhidethehiddentextbyselectingordeselectingtheHiddentextoptionintheDisplayoptionsofMicrosoftWordOptions.

Formfieldsize

TheLargeoptioninsertstheBIPublishercodeinadocumentvariable.Thedocumentvariablefieldcanaccommodateapproximately48kilobytesofcodeline.

Notethatthissettingaffectsonlyfieldsthatarecreatedoreditedwhilethisoptionisset.

TableHeaderColor

WhenyouinsertatablebyusingtheTableWizardortheInsertTable/Formdialogbox,theTemplateBuilderappliesthetableheadercolorspecifiedheretothetableheaderbackground.Usethisfeaturetocustomizethedefaultcolorforyourtemplates.

GenerateXSLT2.0compliantcode

BIPublisherusestheXSLTprocessorprovidedbyOracleXDK11.1.0.7.0,whichsupportstheW3CXSLTransformations1.0recommendation.TheprocessoralsoimplementsthecurrentworkingdraftsoftheXSLTandXPath2.0standards.FormoreinformationaboutOracleXDKseeOracleXMLDeveloper'sKitProgrammer'sGuide11g.

Bydefault,BIPublisheriscompatiblewithXSLT1.0.IfyouwishtouseXSLTandXPath2.0featuresinyourtemplateenablethisoption.Thisconfigurationisperformedatthetemplatelevel.Thetemplatelevelsettingwilloverridetheserversetting.

Thisconcludesthe"SettingConfigurationOptionsforTemplateBuilder"topic.

SummaryInthistutorial,youhavelearnedhowto:

InstallTemplateBuildersuccessfullyCreateanRTFtemplateintheOfflinemodeCreateanRTFtemplateintheOnlinemodeCreateachartandapivottableinanexistingtemplateConfigureTemplateBuildersettings

Resources



OraclebyExampleBusinessIntelligenceEnterpriseEditionOracleLearningLibraryHome

CreditsLeadCurriculumDeveloper:SindhuRaoOtherContributors:KasturiShekhar,MikeDonohue,PradeepSharma,andDanielMilne

Copyright2011,Oracleand/oritsaffiliates.Allrightsreserved
http://www.oracle.com/corporate/index.htmlhttp://www.oracle.com/us/corporate/index.htmlhttp://www.oracle.com/goto/ollhttp://www.oracle.com/technetwork/middleware/bi-enterprise-edition/tutorials/index.html

Creating RTF Templates by Using BI Publisher 11g Template Builder for Word

Documents

Transcript of Creating RTF Templates by Using BI Publisher 11g Template Builder for Word