You are on page 1of 44

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

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord
PerformthefollowingstepstodownloadandinstallTemplateBuilder:
1. LogintoOracleBIPublisher.

2. IntheGetStartedsectionoftheHomepage,clicktheDownloadBIPublisherToolsmenu,andselectTemplate
BuilderforWord.

3. TheOpeningBIPublisherDesktop.exedialogboxopens.ClickSaveFile.Savethefiletoasuitablelocationon
yourharddrive.

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

2/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

4. NavigatetothelocationwhereyouhavedownloadedtheBIPublisherDesktop.exefileanddoubleclickthe
executablefiletobegintheinstallation.

5. a.AftertheInstallShieldwizardstarts,followtheonscreeninstructionstocompletetheinstallation.

b.ClickFinish.

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

3/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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.

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

4/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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.

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

5/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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.

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

6/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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.

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

7/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

5. TheCustomer_NamefieldappearsintheBalanceLetter.ClickthespacefollowingtheCUSTOMER_NAME
andpressEnter.Thisaddsalinebreak.

6. Repeatthisprocess,addingAddressLine1.Also,addCity,State,andZip,eachofthemseparatedbyacomma
andspace.Thelettershouldlooklikethis:

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

8/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

7. a.Insertthefollowingfieldsintotheletter,intheappropriateplaceholders:
As_Of_Date
TrxCurrencyCode
CInvOpenBalance.
NotethatyoumayhavetoscrollintheFielddialogboxtolocatethesefields.
b.ClosetheFieldDialogbox.

8. IncludethetableofinvoicesbyusingtheTableWizard.TheTableWizardallowsyoutoaddtables,forms,charts,
andotherobjects.
a.Selectthe<INSERTTABLEOFINVOICEHERE>placeholderintheformletter.ClickTableWizardinthe
group.

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

9/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

TheTableWizardopens.

b.Acceptthedefault(Table)andclickNext.
9. TheTableWizardintuitivelyselectsthecorrectdatasetforyou.Inthisexample,itis
/ARXCOBLX/G_CUSTOMER/G_CURRENCY/G_INVOICES.AcceptthedefaultandclickNext.

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

10/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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.

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

11/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

12. a.Selectasortsequenceandindicatethetypeofdatathatisbeingsorted.SelectTransactionDate,indicatethat
thisfieldisanumber,andsortthecolumnindescendingorder.

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

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

12/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

14. PreviewthistemplateinPDFformat.InthePreviewgroup,clickPDF.

ThereportisdisplayedwiththeXMLfiledatathatyouloadedearlier.

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

13/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

15. YoucanviewtheWordpropertiesofanytablefieldthatyouhaveaddedtoyourtemplate.Doubleclick
TRANS_AMOUNTinthetable.
TheBIPublisherPropertiesdialogboxisdisplayed.

ClicktheWordPropertiesbuttontoedittheinsertedfields.
16. a.IntheTextFormFieldOptionsdialogbox,selectNumberfromtheTypedropdownlist.

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

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

14/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

c.ClickOK.Thetemplateisdisplayedwiththeappliedformatting.

d.RightjustifythisTransAmountfieldbyusingMSWordParagraphmenu.

17. Youcanformattheotherfieldsasperyourrequirement.However,becausethedateisatextfieldinthisexample,
youwillnotbeabletoformatit.

YoucanalsoformatthecolumnnamesofthetabletoameaningfuldisplayusingtheMSWordmenu.Changethe
columnnamesasgivenbelowandthenkeeptheformattingasBold.
TrxNumbertoInvoiceNumber
TransactionDatetoDate
TransAmounttoTransactionAmount
TransAmountRemainingtoTransactionAmountRemaining

18. SavethetemplateasMyBalanceLetterintheLearnfolderonyourlocaldrive.

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

15/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

19. Whenyoupreviewthistemplate,thereportisdisplayedwiththeappliedformatting.

20. Closethepreviewandthetemplatefile.
21. LogintoBIPublisherEnterpriseEdition.

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

16/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

22. OntheCatalogpage,navigatetotheBalanceLetterreportandclickEdit.
ThisBalanceLetterreportispartoftheSamplesfiles.

23. TheReportEditoropens.ClickAddNewLayout.

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

17/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord
24. ClickUpload.

25. a.EnterBalanceLetterasthelayoutname.
b.ClickBrowse.NavigatetoandselectMyBalanceLetter.rtffromtheLearnfolder,andclickOpen.
c.SelectRTFTemplateasthetypeandEnglish(UnitedStates)asthelocale.

.
d.ClickUpload.
26. Theuploadedlayoutisdisplayedinthelayouteditor.ClickSave.

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

18/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

27. ClickViewReport.

Inthedisplayedreport,clicktheBalanceReporttab.Thereportbasedonthetemplatethatyouhavedesignedin
TemplateBuilderisdisplayed.

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

19/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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

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

20/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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

3. Whenthereportopens,youwillnotseeanydataintheblankMSWorddocument.However,XMLdatadefinitions
areloadedfromthereporttofacilitatethedefinitionofatemplate.Noticethatthereportnameappearsinthetitle
barofMSWordbesidethedocumentname.

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

21/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

4. Nowstartbuildingthetemplate.
Insertawordtablewithtworows.Insertthechartinthefirstrow,followedbythetableinthesecond.

5. Nowyouwilladdachartforthistemplate.Positionyourcursorinthefirstrowofthewordtable.IntheInsertgroup
clickChart.

6. TheChartwindowopens.SelectRowintheDatapane.

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

22/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

7. a.DragAnnualSalarytoValuesintheLayoutpane.
b.DragDepartmentNametotheLabelstextbox.

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

23/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

8. IntheLayoutpane,selectthefollowinginformation:
Step

Attribute

Values

a.

Type

BarGraphVertical

b.

Style

Earth

c.

Aggregation

Average

f.

Title:Title

AverageAnnualSalarybyDepartment

TheChartwizardshouldlooklikethis:

ClickOK.

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

24/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

9. Thechartappearsinthetemplate.

10. NowusetheTablewizardtoinsertthetableinyourtemplate.Youdidthisintheprevioustopic,butinOffline
mode.TakeyourcursertothenextrowoftheMSWordtable,andtheninsertthetable.
a.SelectDepartmentName,Manager,Name,JobTitle,AnnualSalary,andFedWithheld(inthatorder).Your
selectionsshouldbelistedintherightpaneofthewizardpage.

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

25/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

b.ClickNext.
11. IntheHowwouldyouliketogroupyourreport?section,selectthefollowingoptions:
GroupByDepartmentName
GroupAbove
BreakSection
ThenByManager
GroupLeft
RecallthatwhileworkingonthetableintheOfflinemode,youdidnotchooseoptionsforgrouping.Thisexample
usessectionbreaksinthereportwithDepartmentNameasthegroupandhasasecondgroupingbyManagers.

ClickNext.
12. SortbyAnnualSalaryintheWhichfieldswouldyouliketousetosortthedata?section.ClickFinish.

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

26/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

13. Thistableappearsinthedocument,belowthechart.RightjustifythecellforANNUAL_SALARY.

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

27/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

14. SavethefileasManagerFinancialsReport.rtfinyourLearnfolder.

15. SelectthePDFpreviewoptionfromthePreviewgroup.ThePDFisdisplayed.Observethatbecauseyouusedthe
Groupaboveoptionwhileinsertingthetable,adepartmentnameappearsaboveeachtable.

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

28/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

16. ClosethePDF.
17. Now,uploadthetemplatetotheBIPublisherServer.
ClickUploadTemplateAsintheOnlinegroup.

18. Uploadasnewdialogboxopens.EnterManagerFinancialsReportastheTemplateName.

19. Aconfirmationmessageisdisplayed.ClickOK.

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

29/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

20. NavigatetotheSalaryReportNoParametersreportintheBIPublisherEnterpriseServerandclick

21. Theuploadedlayoutisdisplayedinthelayouteditor.SaveandthenclickViewReport.

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

30/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

22. Inthedisplayedreport,clicktheManagerFinancialsReporttab.Thereportbasedonthetemplateyouhave
designedinTemplateBuilderisdisplayed.

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

31/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord
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.

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

32/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

4. ClickOKinthemessagedialogbox.Thedataisloaded.
5. ClickEntertwicetoenteralinebreakafterthePIEChart.

6. ClickPivotTableintheInsertgroup.ThePivotTabledialogboxopens.

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

33/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

YoudragdatacolumnsfromtheDatapanetotheblankLayoutpanetobuildapivottable.
7.

a.DragYeartoColumn
b.DragMonthtoColumn
c.DragIndustrytoRow
d.DragSalestothePleasedropdataherearea.

8. a.SelectSalesintherow.
b.SelectthecelltotherightofFormatinthePropertiespanetoselectSUM.
c.Select#,##0inthepropertiesdropdownlist.

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

34/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

d.ClickOK.
9. Thepivottableappearsinthetemplate.

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

35/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

10. Savethetemplate,andthenclickPDFinthePreviewgrouptoviewyourpivottable.

Thisconcludesthe"WorkingwithaPivotTableinanExistingRTFTemplate"topic.

UsingTemplateBuilderUtilities:FieldBrowser,ValidateTemplate,and
CheckAccessibility
ThistopicwilldemonstratehowtousetheFieldBrowser,CheckAccessibility,andValidateTemplateutilities
availableinTemplateBuilder.
YouwillusetheRetailSales.rtffile,whichismadeavailabletoyouatMyTemplatesandFileszip
file.

UsingValidateTemplate
1 a.OpentheRTFfileRetailSales.rtf.
.

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

36/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

b.IntheBIPublishertab,intheToolsgroup,clickValidateTemplate.

2 Iftherearenovalidationerrors,NoErrorfoundisreturned.
.

Ifanerrorisfound,theerrorwillbedisplayed.
Note:YoucanalsouseFieldBrowsertohelplocatetheerror.

UsingFieldBrowser
TheFieldBrowserutilityprovidesafastwaytoreviewandupdatetheBIPublisherinstructionshiddeninthe
MicrosoftWordformfields.Thisisparticularlyusefulforunderstandingandmodifyingexistingtemplates.

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

37/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord
1. IntheBIPublishertab,intheToolsgroup,clickFieldBrowsertoopentheFieldBrowserdialogbox.

2. TheFieldBrowserdialogboxshowsthedefaulttextoftheformfieldintheTextcolumn,andtheinstructions(from
thehelpandstatustextoftheformfield)intheCodecolumn.

Note:

Whenyouselectaspecificrowinthedialogbox,thematchingformfieldwillbeselectedintheMicrosoftWord
document.
IfyouselectsomepartofthetextbeforeopeningtheFieldBrowser,thedialogshowsonlythefieldsinyour
selection.Ifnotextisselected,FieldBrowserwillshowallfieldsinthedocument.Thisscreenshotshowsall

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

38/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord
thefields,becausenospecificformfieldwasselectedbeforeopeningFieldBrowser.

3. YoucanupdateprocessinginstructionsdirectlyfromtheFieldBrowserdialogbox.
a.SelectINDUSTRYintheTextcolumn..

TheEditfieldshowstheprocessinginstructions.
b.ChangeallbutthefirstofthecapitallettersofthewordINDUSTRYtolowercase.Inotherwords,change
INDUSTRYtoIndustry.
c.SelectUpdate.

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

39/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

Observethatthecodeischangedasperyouredit.
Note:RecallfromtheprevioustopicthatyoucanuseFieldBrowsertofindoutvalidationerrorsinthetemplate.
UsetheFindoptionintheFieldBrowsertosearchfortheerrors.

UsingCheckAccessibility
TemplateBuilderprovidesanaccessibilitycheckertocheckthetemplateforfeaturestoenhancethe
accessibilityofthereportforreportconsumerswhomayneedassistingtechnologiestoviewthereport.For
moreinformationaboutdevelopingaccessiblereports,see"DesigningAccessibleReports"intheOracle
FusionMiddlewareReportDesigner'sGuideforOracleBusinessIntelligencePublisher.
1. IntheBIPublishertab,intheToolsgroup,clickCheckAccessibility.

2. Thetoolgeneratesareportindicatingareasofyourtemplatethatdonotincludetheaccessibilityfeatures.

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

40/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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

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

41/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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

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

42/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord

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
http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm

43/44

5/10/2015

CreatingRTFTemplatesbyUsingBIPublisher11gTemplateBuilderforWord
OraclebyExampleBusinessIntelligenceEnterpriseEdition
OracleLearningLibraryHome

Credits
LeadCurriculumDeveloper:SindhuRao
OtherContributors:KasturiShekhar,MikeDonohue,PradeepSharma,andDanielMilne

Copyright2011,Oracleand/oritsaffiliates.Allrightsreserved

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

44/44