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

5/10/2015
CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord
CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilder
forWord
Purpose
ThistutorialcovershowtouseOracleBusinessIntelligencePublisherTemplateBuilderforMSWordto
createRTFtemplates.
Youwilllearnhowto:
LogontoBIPublisherServerandcreateRTFtemplatesinOnlinemode
UsetheSampleXML/XMLschematocreateRTFtemplatesinOfflinemode
Createtabularreports
Createchartsandpivottables
Insertfieldsandrepeatinggroups
UsenativeMSWordformatting
Usetoolstovalidatetemplates,browsefields,andcheckaccessibility
TimetoComplete
Approximately2hours.
Overview
TemplateBuilderisanextensiontoMSWord(2003orlater)thatsimplifiesRTFtemplatecreationforOracle
BIPublisherreports.
RichTextFormat(RTF)isaspecificationusedbycommonwordprocessingapplications,suchasMSWord.
TemplateBuilderprovideseasytousewizardsforinsertingfields,tables,forms,charts,andcrosstabs.
Also,TemplateBuilderprovidestranslationfeaturesandenablesyoutopreviewreportsbyusingthe
templateinsupportedformats.
ThistutorialprovidesstepbystepprocedurestouseTemplateBuildertocreateRTFtemplatesforOracleBI
Publisherreports.TheexampleswillcovercomplexformattingandprocessingofreportsbyusingtheseRTF
templates.YouwillalsolearnhowtoworkinbothOnlineandOfflinemodes.TranslatingtheRTFtemplates
iscoveredindetailintheothertutorial:ExploringAdvancedFeaturesofBIPublisher11g,andalsointhe
InstructorLedTraining(ILT)forBIPublisher11g.
Prerequisites
Tocompletethistutorial,youshould:
DownloadtheMyTemplatesandFileszipfile,andunzipinafolderwiththesamename.
CreateaLearnfolderonyourharddrive.
HaveaccesstotheSamplesfilesavailableinthePublisherDesktopProgrammenu.
YouwillbeusingsomeofthereportsthataresimilartotheonesyoucreatedintheOBE'GettingStarted
withOracleBusinessIntelligencePublisher'.ThesereportsareprovidedtoyouintheMyTemplates
andFileszipfile.
CompletetheGettingStartedwithOracleBusinessIntelligencePublisherOBEmentionedabove.
Installtherequiredsoftware.
Theassumptionthroughoutthiscourseisthatyouarefamiliarwiththebasicuserinterfaceandnavigationof
theOracleBIPublisher.
SoftwareRequirements
Thefollowingisalistofsoftwarerequirements:
MicrosoftWord(2003or2007)
JavaSEDevelopmentKit(JDK)5orlater(ThisalsoincludesJavaRuntimeEnvironment[JRE].JRE1.6
orlaterisrequired.)
MS.NETFramework3.5withSP1orlater.
OracleBIEE11ginstalledonamachinethatTemplateBuildercanconnecttobyusingHTTP.
OracleBIEE11gshouldbeabletoconnecttoasupporteddatasource.
InstallingTemplateBuilderandExploringtheTemplateBuilderUser
Interface
Inthistopic,youwillseehowtodownloadtheTemplateBuilderaddin,andinstallit.Thenyouwillexplore
thetheTemplateBuilderuserinterface.
InstallingTemplateBuilder
TemplateBuildercanbedownloadedfromtheGetStartedregionoftheOracleBIPublisherHomepageor
OracleBIEEHomepage.Inthistopic,youwilldownloadtheTemplateBuilderaddinandinstallit.
http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm
1/44
5/10/2015
PerformthefollowingstepstodownloadandinstallTemplateBuilder:
1. LogintoOracleBIPublisher.
2. IntheGetStartedsectionoftheHomepage,clicktheDownloadBIPublisherToolsmenu,andselectTemplate
BuilderforWord.
3. TheOpeningBIPublisherDesktop.exedialogboxopens.ClickSaveFile.Savethefiletoasuitablelocationon
yourharddrive.
2/44
5/10/2015
4. NavigatetothelocationwhereyouhavedownloadedtheBIPublisherDesktop.exefileanddoubleclickthe
executablefiletobegintheinstallation.
5. a.AftertheInstallShieldwizardstarts,followtheonscreeninstructionstocompletetheinstallation.
b.ClickFinish.
3/44
5/10/2015
6. IfTemplateBuilderisinstalledcorrectly,youwillseetheBIPublisherribboninWord2007:
Note:IfyouareusingMicrosoftWord2007youmayneedtomodifyyourAddInsettings:Todoso,clicktheOffice
button,clickWordOptions,andthenclickAddIns.
ExploringtheTemplateBuilderUserInterface
Inthistopic,youwillreviewTemplateBuilderUIcomponents.Youwillopentheexisting
Balanceletter.rtffile.
(ThisfileismadeavailabletoyouintheMyTemplatesandFileszipfile,aswellasinSampleafteryou
installtheTemplateBuilder.)
1. TheBIPublisherribbonhasthefollowingoptions:
Online
YoucanlogintoBIPublisherfromhere.Afteryoulogin,youcanusetheOpenbuttontoopenareport
theBIPublishercatalog.
LoadData
PrintPreview
CreatingRTF
TemplatesbyUsing
BIPublisher11g
TemplateBuilderfor
Word
ThisgroupofcommandsenablesyoutoloadasavedsampledatafileorsampleschematoTemplateBuilder
YoumustloaddatatousemostoftheTemplateBuilderfunctionality.TheSampleXMLbuttonallowsyouto
loadasampleXMLfilethatcontainsallthefieldsthatyouwanttoinsertintoyourtemplateasadatasource.
youarenotconnectedtotheBIPublisherserver,usethismethodtoloadyourdata.
Insert
Thistutorialcontainsthe
followingsections:
Purpose
TimetoComplete
Overview
Prerequisites
SoftwareRequirements
ThisgroupenablesyoutoinsertthefollowingelementsintoyourRTFtemplate.
TableWizard:Thisfunctionprovidesawizardthatguidesyouthroughthecreationoftablesusedin
typicalreports.
4/44
5/10/2015
InstallingTemplateBuilder
andExploringtheTemplate
BuilderUserInterface
BuildinganRTFTemplatein
OfflineMode
BuildinganRTFTemplatein
OnlineMode
WorkingwithaPivotTable
inanExistingRTF
Template
UsingTemplateBuilder
Utilities:FieldBrowser,
ValidateTemplate,and
CheckAccessibility
PivotTable:Usingthisyoucandraganddropdataelementsintoapivottable.
Chart:BIPublisherdoesnotrecognizenativeMicrosoftWordcharts.TheInsertChartfunctionallowsyou
toinsertachartthatisunderstoodbyOracleBIPublisher.
ab|Field:Thisfunctionallowsyoutoselectfieldsfromyourdatasourceandinsertthemintoyourtemplate
Table/Form:Usethisfunctiontoinsertdatafieldstobeorganizedasasimpleornestedtableorasaform
thatisrepeatedwithdifferentdata.Youmayevenorganizeallthedatafieldsforthewholedocument
beforeinsertingthem.
RepeatingGroup:Usethistoselectordefineagroupofelementstoberepeatedforeachoccurrenceof
anelementinthedata.
ConditionalFormat:Thisenablesyoutodefinesimpleconditionalformatstoapplytotablerowsorcells.
SettingConfiguration
OptionsforTemplate
Builder
ConditionalRegion:Thisenablesyoutoinsertaconditionalstatementaroundaregionofthetemplate.A
conditionalregionisanareathatissurroundedbyaconditionalstatement.Ifthestatementteststrue,the
areaisdisplayedinthereportiftheconditiontestsfalse,theareaissuppressedfromthereport.
Summary
AllFields:ThisfunctioninsertsallfieldsfoundintheXMLdataintoyourdocument.Itwillalsoinsert
processinginstructionsintoyourdocumentthatwillrepeatasection,suchasatablerowwhenthe
associatedXMLelementisrepeated.Whenyouareworkingonadeeplynestedhierarchyofelements,it
isbettertoinsertelementsseparately,insteadofinsertingallfields.
Resources
Viewing
Screenshots
Preview
Clickicontohideall
screenshots
Note:Alternatively,youcan
clickanindividualicon(or
image)associatedwitheach
steptoview(orhide)the
screenshotassociatedwiththat
step.
ThisenablesyoutopreviewyourRTFtemplatewithsampleXMLdata.ThepreviewmenuoffersyouPDF,
HTML,RTF,PowerPoint,Excel(MHTMLformat),andEXCEL2000asoutputformats.Whenyouselectanyof
theseoutputformats,TemplateBuilderwillmergethedataintoyourtemplateandcreatetheoutputdocument
Tools
Thisgrouphasthefollowingadvancededitingtoolsforthetemplates:
FieldBrowser:ThisisforadvanceduserstoreviewandeditBIPublishercommandsinsertedintheform
fields.Itshowsthecommandsbehindeachformfieldandallowsyoutoeditthem.Usethistooltocorrect
flawedRTFtemplatesortoupdatemultiplefieldsefficiently.
ValidateTemplate:ThevalidationfunctionchecksthetemplateforincorrectuseofBIPublisher
commandsandunsupportedelementsintheWordfile.
CheckAccessibility:Runthistooltocheckfortheaccessibilityfeaturesinthetemplate.
Translation:
ExtractText:ThiscommandenablesyoutocreateastandardXLIFFtranslationfilecontainingthe
boilerplatetextfromyourtemplate.XLIFFisastandardfileformatthatisunderstoodbymanytranslation
softwarepackages.BecauseanXLIFFisanXMLfile,youcantranslatethetextinatexteditor.
PreviewTranslation:ThiscommandenablesyoutopreviewyourtemplateasaPDFfileusingaspecified
XLIFFtranslationfile.Thisfunctionalityenablesyoutotesttranslationfiles.
LocalizeTemplate:ThiscommandappliesatranslationfiletoanRTFtemplate.Thismeansthatinyour
currentRTFtemplateallboilerplatetextistranslated.Themainfunctionofthisfeatureistocreatea
languagespecificversionofatemplate.
Export
XSLFOStylesheet:ThisfunctionallowsyouconverttheRTFtemplateintoanenhancedXSLFO
stylesheet.ThisfunctioncanbeusedtogenerateXSLFOfordebuggingorfurthercustomization.
FOFormattedXML:ThisfunctionallowsyoutoapplytheXSLFOstylesheetgeneratedfromtheWord
documenttothesampledataandsavetheintermediateFOformat.Thisfunctionismainlyfordebugging.
PDFThisfunctionconvertstheWorddocumenttoPDF.
Options
ThisgroupallowsyoutochangethefollowingoptionsthatinfluencethelookandfeelofTemplateBuilder:
DisplayMode
Preview
Build
Youwilluseallthesefunctionsinthecomingsections.
5/44
5/10/2015
BuildinganRTFTemplateinOfflineMode
RichTextFormat(RTF)isaspecificationusedbycommonwordprocessingapplications,suchasMicrosoft
Word.WhenyousaveatemplateinTemplateBuilder,thefiletypeshouldbeRTF.Youcanbuildandupload
yourtemplateviaadirectconnectionwiththeBIPublisherServer,calledOnlinemode,oryoucanbuildand
uploadyourtemplateinadisconnectedmode,andiscalledOfflinemode.
Note:Toworkindisconnectedmode,youmusthaveasampledatafileavailableinyourlocalwork
environment.Inthisexample,thesampledatafileisBalance.XML.
1. a.SelectStart>Programs>OracleBIPDesktop>Samples>RTFTemplates.
b.OpentheBalanceLetterfolderandloadthefileBalanceLetterStart.rtf.Thisisasampletemplatefile.
2. TheRTFtemplatefileopensinMSWord.
3. Tobuildareportandviewthereportwithdata,youmustloadsampleXMLdata.Whenworkingindisconnectedo
Offlinemode,youmusthavesampledatastoredlocally.
a.ClickSampleXMLintheLoadDatagroup.
6/44
5/10/2015
b.SelecttheBalance.xmlsampledatafilelocatedunderyourlocaldrive(C):\Program
Files\Oracle\BIPublisher\BIPublisherDesktop\samples\RTFtemplates\BalanceLetter.
ClickOpen.
Youwillseeaconfirmationmessagethatthedataisloadedsuccessfully.
4. a.NowinsertthevariousfieldsintheBalanceLetterbyreplacingtheplaceholders.Selectthe<INSERT
ADDRESSHERE>placeholder,andclickab|Field,intheInsertgroup.
b.IntheFielddialogbox,selecttheCustomerNamefieldandclickInsert.
7/44
5/10/2015
5. TheCustomer_NamefieldappearsintheBalanceLetter.ClickthespacefollowingtheCUSTOMER_NAME
andpressEnter.Thisaddsalinebreak.
6. Repeatthisprocess,addingAddressLine1.Also,addCity,State,andZip,eachofthemseparatedbyacomma
andspace.Thelettershouldlooklikethis:
8/44
5/10/2015
7. a.Insertthefollowingfieldsintotheletter,intheappropriateplaceholders:
As_Of_Date
TrxCurrencyCode
CInvOpenBalance.
NotethatyoumayhavetoscrollintheFielddialogboxtolocatethesefields.
b.ClosetheFieldDialogbox.
8. IncludethetableofinvoicesbyusingtheTableWizard.TheTableWizardallowsyoutoaddtables,forms,charts,
andotherobjects.
a.Selectthe<INSERTTABLEOFINVOICEHERE>placeholderintheformletter.ClickTableWizardinthe
group.
9/44
5/10/2015
TheTableWizardopens.
b.Acceptthedefault(Table)andclickNext.
9. TheTableWizardintuitivelyselectsthecorrectdatasetforyou.Inthisexample,itis
/ARXCOBLX/G_CUSTOMER/G_CURRENCY/G_INVOICES.AcceptthedefaultandclickNext.
10/44
5/10/2015
Youcanchangethis,however,byclickingthedropdownlist.
10. a.Selectthefollowingcolumns:
TrxNumber
TransactionDate
TransAmount
TransAmount(Second"TransAmount"isTransAmountRemaining)
Usetheshuttleicons
tomoveitemstotheselectedcolumnoneatatimeorusethedoubleheadedshuttle
iconstomoveallcolumnsatonce.
Usetheresequenceicons
tomovethecolumnsupanddown.
b.ClickNext.
11. Youcangroupyourdata.YouusetheBreakoptiontoinserteitherapagebreakorsectionbreakaftereach
occurrenceofagroup.Inthisexampleyouwillnotselectanyoptions.ClickNext.
11/44
5/10/2015
12. a.Selectasortsequenceandindicatethetypeofdatathatisbeingsorted.SelectTransactionDate,indicatethat
thisfieldisanumber,andsortthecolumnindescendingorder.
b.ClickFinish.
13. Thetableopensinthetemplate.ObservethecodesF(for"Grouping")andE(for"Each")inthetable.
12/44
5/10/2015
14. PreviewthistemplateinPDFformat.InthePreviewgroup,clickPDF.
ThereportisdisplayedwiththeXMLfiledatathatyouloadedearlier.
13/44
5/10/2015
15. YoucanviewtheWordpropertiesofanytablefieldthatyouhaveaddedtoyourtemplate.Doubleclick
TRANS_AMOUNTinthetable.
TheBIPublisherPropertiesdialogboxisdisplayed.
ClicktheWordPropertiesbuttontoedittheinsertedfields.
16. a.IntheTextFormFieldOptionsdialogbox,selectNumberfromtheTypedropdownlist.
b.Setthedefaultnumberandnumberformat.Enter$1,000.00intheDefaultnumbertextboxandselect
$#,##0.00fromtheNumberformatdropdownlist.
14/44
5/10/2015
c.ClickOK.Thetemplateisdisplayedwiththeappliedformatting.
d.RightjustifythisTransAmountfieldbyusingMSWordParagraphmenu.
17. Youcanformattheotherfieldsasperyourrequirement.However,becausethedateisatextfieldinthisexample,
youwillnotbeabletoformatit.
YoucanalsoformatthecolumnnamesofthetabletoameaningfuldisplayusingtheMSWordmenu.Changethe
columnnamesasgivenbelowandthenkeeptheformattingasBold.
TrxNumbertoInvoiceNumber
TransactionDatetoDate
TransAmounttoTransactionAmount
TransAmountRemainingtoTransactionAmountRemaining
18. SavethetemplateasMyBalanceLetterintheLearnfolderonyourlocaldrive.
15/44
5/10/2015
19. Whenyoupreviewthistemplate,thereportisdisplayedwiththeappliedformatting.
20. Closethepreviewandthetemplatefile.
21. LogintoBIPublisherEnterpriseEdition.
16/44
5/10/2015
22. OntheCatalogpage,navigatetotheBalanceLetterreportandclickEdit.
ThisBalanceLetterreportispartoftheSamplesfiles.
23. TheReportEditoropens.ClickAddNewLayout.
17/44
5/10/2015
24. ClickUpload.
25. a.EnterBalanceLetterasthelayoutname.
b.ClickBrowse.NavigatetoandselectMyBalanceLetter.rtffromtheLearnfolder,andclickOpen.
c.SelectRTFTemplateasthetypeandEnglish(UnitedStates)asthelocale.
.
d.ClickUpload.
26. Theuploadedlayoutisdisplayedinthelayouteditor.ClickSave.
18/44
5/10/2015
27. ClickViewReport.
Inthedisplayedreport,clicktheBalanceReporttab.Thereportbasedonthetemplatethatyouhavedesignedin
TemplateBuilderisdisplayed.
19/44
5/10/2015
ThisconcludesthetopiconcreatingaRTFtemplateusingTemplateBuilderinOfflinemode.
BuildinganRTFTemplateinOnlineMode
ThistopicdemonstrateshowtodesignanRTFtemplatewhileloggedintoBIPublisher.
YouwilllogintoBIPublisherthroughTemplateBuilder,defineanRTFtemplate,addatablewitharunning
total,addgroupingandsorting,addapagebreak,addachart,previewdatainthereportbyusingthe
template,uploadtheRTFtemplatetoBIPublisherEnterpriseServer,andviewthereportonBIPublisher
EnterpriseServer.
1. a.Openanewblankworddocument.
b.LogintoBIPublisherbyclickingLogOnintheOnlinegroup.
c.EntertheReportServerURLastheBIPublisherServerinstalledonyourmachine.Forexample,http://<host>:
<port>/xmlpserver
20/44
5/10/2015
d.ClickLogin.
2. TheOpenTemplatedialogboxopens.SelecttheSalaryReportsNoParametersreport.(Navigateto
\SharedFolders\SampleLite\PublishedReporting\Reports\)
3. Whenthereportopens,youwillnotseeanydataintheblankMSWorddocument.However,XMLdatadefinitions
areloadedfromthereporttofacilitatethedefinitionofatemplate.Noticethatthereportnameappearsinthetitle
barofMSWordbesidethedocumentname.
21/44
5/10/2015
4. Nowstartbuildingthetemplate.
Insertawordtablewithtworows.Insertthechartinthefirstrow,followedbythetableinthesecond.
5. Nowyouwilladdachartforthistemplate.Positionyourcursorinthefirstrowofthewordtable.IntheInsertgroup
clickChart.
6. TheChartwindowopens.SelectRowintheDatapane.
22/44
5/10/2015
7. a.DragAnnualSalarytoValuesintheLayoutpane.
b.DragDepartmentNametotheLabelstextbox.
23/44
5/10/2015
8. IntheLayoutpane,selectthefollowinginformation:
Step
Attribute
Values
a.
Type
BarGraphVertical
b.
Style
Earth
c.
Aggregation
Average
f.
Title:Title
AverageAnnualSalarybyDepartment
TheChartwizardshouldlooklikethis:
ClickOK.
24/44
5/10/2015
9. Thechartappearsinthetemplate.
10. NowusetheTablewizardtoinsertthetableinyourtemplate.Youdidthisintheprevioustopic,butinOffline
mode.TakeyourcursertothenextrowoftheMSWordtable,andtheninsertthetable.
a.SelectDepartmentName,Manager,Name,JobTitle,AnnualSalary,andFedWithheld(inthatorder).Your
selectionsshouldbelistedintherightpaneofthewizardpage.
25/44
5/10/2015
b.ClickNext.
11. IntheHowwouldyouliketogroupyourreport?section,selectthefollowingoptions:
GroupByDepartmentName
GroupAbove
BreakSection
ThenByManager
GroupLeft
RecallthatwhileworkingonthetableintheOfflinemode,youdidnotchooseoptionsforgrouping.Thisexample
usessectionbreaksinthereportwithDepartmentNameasthegroupandhasasecondgroupingbyManagers.
ClickNext.
12. SortbyAnnualSalaryintheWhichfieldswouldyouliketousetosortthedata?section.ClickFinish.
26/44
5/10/2015
13. Thistableappearsinthedocument,belowthechart.RightjustifythecellforANNUAL_SALARY.
27/44
5/10/2015
14. SavethefileasManagerFinancialsReport.rtfinyourLearnfolder.
15. SelectthePDFpreviewoptionfromthePreviewgroup.ThePDFisdisplayed.Observethatbecauseyouusedthe
Groupaboveoptionwhileinsertingthetable,adepartmentnameappearsaboveeachtable.
28/44
5/10/2015
16. ClosethePDF.
17. Now,uploadthetemplatetotheBIPublisherServer.
ClickUploadTemplateAsintheOnlinegroup.
18. Uploadasnewdialogboxopens.EnterManagerFinancialsReportastheTemplateName.
19. Aconfirmationmessageisdisplayed.ClickOK.
29/44
5/10/2015
20. NavigatetotheSalaryReportNoParametersreportintheBIPublisherEnterpriseServerandclick
21. Theuploadedlayoutisdisplayedinthelayouteditor.SaveandthenclickViewReport.
30/44
5/10/2015
22. Inthedisplayedreport,clicktheManagerFinancialsReporttab.Thereportbasedonthetemplateyouhave
designedinTemplateBuilderisdisplayed.
31/44
5/10/2015
Thisconcludes"BuildinganRTFTemplateinOnlineMode"topic.
WorkingwithaPivotTableinanExistingRTFTemplate
ThistopiccoversaddingapivottabletoanexistingRTFtemplate.YouwillopenanexistingRTFtemplateto
previewachart,andaddapivottabletothetemplate.TheRTFtemplateRetailSales.rtfisstoredin
theMyTemplatesandFileszipfile.
1. OpentheRetailSales.rtffileinMSWord.Thefilelookslikethis:
2. IntheBIPublisherribbon,clickSampleXMLintheLoadDatagroup.
3. NavigatetoandselectRetailSales.xml(locatedinthesamefolderastheRetailSalesRTFtemplate),and
clickOpen.Thisfilecontainsretailsalesdatafromdifferentindustries.
32/44
5/10/2015
4. ClickOKinthemessagedialogbox.Thedataisloaded.
5. ClickEntertwicetoenteralinebreakafterthePIEChart.
6. ClickPivotTableintheInsertgroup.ThePivotTabledialogboxopens.
33/44
5/10/2015
YoudragdatacolumnsfromtheDatapanetotheblankLayoutpanetobuildapivottable.
7.
a.DragYeartoColumn
b.DragMonthtoColumn
c.DragIndustrytoRow
d.DragSalestothePleasedropdataherearea.
8. a.SelectSalesintherow.
b.SelectthecelltotherightofFormatinthePropertiespanetoselectSUM.
c.Select#,##0inthepropertiesdropdownlist.
34/44
5/10/2015
d.ClickOK.
9. Thepivottableappearsinthetemplate.
35/44
5/10/2015
10. Savethetemplate,andthenclickPDFinthePreviewgrouptoviewyourpivottable.
Thisconcludesthe"WorkingwithaPivotTableinanExistingRTFTemplate"topic.
UsingTemplateBuilderUtilities:FieldBrowser,ValidateTemplate,and
CheckAccessibility
ThistopicwilldemonstratehowtousetheFieldBrowser,CheckAccessibility,andValidateTemplateutilities
availableinTemplateBuilder.
YouwillusetheRetailSales.rtffile,whichismadeavailabletoyouatMyTemplatesandFileszip
file.
UsingValidateTemplate
1 a.OpentheRTFfileRetailSales.rtf.
.
36/44
5/10/2015
b.IntheBIPublishertab,intheToolsgroup,clickValidateTemplate.
2 Iftherearenovalidationerrors,NoErrorfoundisreturned.
.
Ifanerrorisfound,theerrorwillbedisplayed.
Note:YoucanalsouseFieldBrowsertohelplocatetheerror.
UsingFieldBrowser
TheFieldBrowserutilityprovidesafastwaytoreviewandupdatetheBIPublisherinstructionshiddeninthe
MicrosoftWordformfields.Thisisparticularlyusefulforunderstandingandmodifyingexistingtemplates.
37/44
5/10/2015
1. IntheBIPublishertab,intheToolsgroup,clickFieldBrowsertoopentheFieldBrowserdialogbox.
2. TheFieldBrowserdialogboxshowsthedefaulttextoftheformfieldintheTextcolumn,andtheinstructions(from
thehelpandstatustextoftheformfield)intheCodecolumn.
Note:
Whenyouselectaspecificrowinthedialogbox,thematchingformfieldwillbeselectedintheMicrosoftWord
document.
IfyouselectsomepartofthetextbeforeopeningtheFieldBrowser,thedialogshowsonlythefieldsinyour
selection.Ifnotextisselected,FieldBrowserwillshowallfieldsinthedocument.Thisscreenshotshowsall
38/44
5/10/2015
thefields,becausenospecificformfieldwasselectedbeforeopeningFieldBrowser.
3. YoucanupdateprocessinginstructionsdirectlyfromtheFieldBrowserdialogbox.
a.SelectINDUSTRYintheTextcolumn..
TheEditfieldshowstheprocessinginstructions.
b.ChangeallbutthefirstofthecapitallettersofthewordINDUSTRYtolowercase.Inotherwords,change
INDUSTRYtoIndustry.
c.SelectUpdate.
39/44
5/10/2015
Observethatthecodeischangedasperyouredit.
Note:RecallfromtheprevioustopicthatyoucanuseFieldBrowsertofindoutvalidationerrorsinthetemplate.
UsetheFindoptionintheFieldBrowsertosearchfortheerrors.
UsingCheckAccessibility
TemplateBuilderprovidesanaccessibilitycheckertocheckthetemplateforfeaturestoenhancethe
accessibilityofthereportforreportconsumerswhomayneedassistingtechnologiestoviewthereport.For
moreinformationaboutdevelopingaccessiblereports,see"DesigningAccessibleReports"intheOracle
FusionMiddlewareReportDesigner'sGuideforOracleBusinessIntelligencePublisher.
1. IntheBIPublishertab,intheToolsgroup,clickCheckAccessibility.
2. Thetoolgeneratesareportindicatingareasofyourtemplatethatdonotincludetheaccessibilityfeatures.
40/44
5/10/2015
Thistemplatedoesnothaveaccessibilitycompatibilityforarowheaderofatable.
Formoreinformationaboutdevelopingaccessiblereports,seeDesigningAccessibleReports"intheOracle
FusionMiddlewareReportDesigner'sGuideforOracleBusinessIntelligencePublisher.
SettingConfigurationOptionsforTemplateBuilder
Inthistopic,youwillseehowtosetthevariousUIoptionsandconfigurationoptionsforTemplateBuilder.
Theimportantsettingscoveredare:
TheUIOptionstaballowsyoutochangesomeoptionsthatinfluencethelookandfeelofTemplate
Builder.
ThePreviewOptionstaballowsyoutospecifyoptionsthatinfluencethePreviewfunctionalityof
TemplateBuilder.
TheBuildOptionstaballowsyoutospecifyoptionsthatinfluencehowTemplateBuildergenerates
tablesandforms.
SettingUIOptions
ThetreeviewshowingthedatasourcecanshoweitherthecorrectXMLtagnamesofthedatasourceor
aslightlymodifiedversionthatiseasiertoread.
SelecttheElementNamesforReportsXMLoptiontoshowthemodifiedlabels.Theselabelscontain
no<>characters,usetitlecasecapitalizationandusespacesinsteadofunderscores.
SettingPreviewOptions
ThePreviewtaballowsyoutospecifyoptionsthatinfluencethePreviewfunctionalityofTemplate
Builder.
Thevariousoptionsthatyoucansetusingthisdialogare:
StyleTemplate
Locale
JavaHome
JavaOption
41/44
5/10/2015
StyleTemplate
IfyouhaveaBIPublisherstyletemplateavailablelocallyyoucanspecifyithere.Thestyleinformationin
thestyletemplateisappliedtoRTFlayoutsatruntimetoachieveaconsistentlookandfeelforyour
enterprisereports.Inthisexamplenostyletemplateisdefined.
Formoreinformation,see"CreatingandImplementingStyleTemplates"intheOracleFusion
MiddlewareReportDesigner'sGuideforOracleBusinessIntelligencePublisher.
Locale
Youcanchoosethelanguageandterritoryusedforpreviewingyourtemplate.Whilethischangewillnot
automaticallytranslateanyfiles,itisimportanttosetthecorrectlocaleforthepreviewtousethecorrect
directionofthetext(lefttorightorrighttoleft),andtocorrectlysetlocalespecificdate,number,and
currencyformats.InthisexampletheLocaleissettoEnglishUnitedStates[enUS]
JavaHome
ThePreview(andexportfunctionality)requiresJavacode.YoucanchangethepathtoyourJAVA
HOMEdirectory.Ifthisoptionisnotspecified,TemplateBuilderassumesthattheJavavirtualmachine
(java.exe)isaccessibleinthePATHspecifiedinyourenvironmentvariablesofWindows.Inthisexample
itissetasC:\ProgramFiles\Java\jre6
JavaOption
SpecifythememorytoreserveforTemplateBuildertoprocessthetemplate.Thedefaultvalueis
Xmx256M.Theexampleshowsthesame.
SettingBuildOptions
UsetheBuildtabtospecifyoptionsthatinfluencehowTemplateBuildergeneratestablesandforms.
ThevariousBuildoptionsthatyoucansethereare:
Foreachformfield
Formfieldsize
TableHeaderColor
42/44
5/10/2015
Foreachformfield
UsethistochoosehowtheTemplateBuildercreatestheformfieldsforprocessinginstructionsinthe
InsertTable/Formdialogbox.TheDescriptiveoption(forexample:foreachInvoice)rendersa
descriptiveformfieldfortheprocessinginstructions.Thisoptionmakesthelayouttemplateeasierto
understand.However,thelongerfieldsmaydistractfromthevisuallayoutofthetemplate.The
Abbreviatedoption(forexample:F)providesaoneletterabbreviationforeachinstruction.
SelecttheHiddenoptiontogeneratetheprocessinginstructionformfieldsusingMicrosoftWord'shidden
fonteffect.Hiddentextishiddenintheprintpreview.Youcandisplayorhidethehiddentextbyselecting
ordeselectingtheHiddentextoptionintheDisplayoptionsofMicrosoftWordOptions.
Formfieldsize
TheLargeoptioninsertstheBIPublishercodeinadocumentvariable.Thedocumentvariablefieldcan
accommodateapproximately48kilobytesofcodeline.
Notethatthissettingaffectsonlyfieldsthatarecreatedoreditedwhilethisoptionisset.
TableHeaderColor
WhenyouinsertatablebyusingtheTableWizardortheInsertTable/Formdialogbox,theTemplate
Builderappliesthetableheadercolorspecifiedheretothetableheaderbackground.Usethisfeatureto
customizethedefaultcolorforyourtemplates.
GenerateXSLT2.0compliantcode
BIPublisherusestheXSLTprocessorprovidedbyOracleXDK11.1.0.7.0,whichsupportstheW3CXSL
Transformations1.0recommendation.Theprocessoralsoimplementsthecurrentworkingdraftsofthe
XSLTandXPath2.0standards.FormoreinformationaboutOracleXDKseeOracleXMLDeveloper'sKit
Programmer'sGuide11g.
Bydefault,BIPublisheriscompatiblewithXSLT1.0.IfyouwishtouseXSLTandXPath2.0featuresin
yourtemplateenablethisoption.Thisconfigurationisperformedatthetemplatelevel.Thetemplatelevel
settingwilloverridetheserversetting.
Thisconcludesthe"SettingConfigurationOptionsforTemplateBuilder"topic.
Summary
Inthistutorial,youhavelearnedhowto:
InstallTemplateBuildersuccessfully
CreateanRTFtemplateintheOfflinemode
CreateanRTFtemplateintheOnlinemode
Createachartandapivottableinanexistingtemplate
ConfigureTemplateBuildersettings
Resources
43/44
5/10/2015
OraclebyExampleBusinessIntelligenceEnterpriseEdition
OracleLearningLibraryHome
Credits
LeadCurriculumDeveloper:SindhuRao
OtherContributors:KasturiShekhar,MikeDonohue,PradeepSharma,andDanielMilne
Copyright2011,Oracleand/oritsaffiliates.Allrightsreserved
44/44

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

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

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

Uploaded by

Copyright:

Available Formats

5/10/2015

You might also like