Sie sind auf Seite 1von 112

GuideforHCMExtracts

OracleOnlineTrainingMaterialsUsageAgreement
Useoftheinformation,documentsandonlinetrainingcourses(collectively,Materials)foundonthisareaoftheSiteconstitutesagreement
withthefollowingtermsandconditions(aswellasthosesetforthinthePurposeandDisclaimersectionsbelow):
1.Oracleispleasedtoallowitsbusinesspartner(Partner)todownloadandcopytheMaterialsfoundonthisareaoftheSite.TheMaterialsare
proprietaryinformationofOracle.Partnerorotherthirdpartyatnotimehasanyrighttoresell,redistributeorcreatederivativeworksfromthe
Materials.TheuseoftheMaterialsisrestrictedtothenoncommercial,internaltrainingofthePartnersemployeesonly.TheMaterialsmaynot
beusedfortraining,promotion,orsalestocustomersorotherpartnersorthirdparties.
2.OracleisaregisteredtrademarkofOracleCorporationand/oritsaffiliates.Othernamesmaybetrademarksoftheirrespectiveowners.
3.OracledisclaimsanywarrantiesorrepresentationsastotheaccuracyorcompletenessofanyMaterials.Materialsareprovided"asis"
withoutwarrantyofanykind,eitherexpress,impliedorstatutory,includingwithoutlimitationtheimpliedwarrantiesofmerchantability,
satisfactoryquality,fitnessforaparticularpurpose,accuracy,timelinessandnoninfringementofthirdpartyrights.Theinformationcontained
hereinissubjecttochangewithoutnotice.
4.UndernocircumstancesshallOraclebeliableforanyloss,damage,liabilityorexpenseincurredorsufferedwhichisclaimedtohaveresulted
fromuseoftheseMaterials.AsaconditionofuseoftheMaterials,PartneragreestoindemnifyOraclefromandagainstanyandallactions,
claims,losses,damages,liabilitiesandexpenses(includingreasonableattorneys'fees)arisingoutofPartnersuseoftheMaterials.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page1of112

GuideforHCMExtracts

Purpose:
ThisdocumentprovidesanoverviewoffeaturesandenhancementsincludedinOracleFusionApplications11gR1Release11.1.1.5.0and
applicableupdates.ItisintendedsolelytohelpyouassessthebusinessbenefitsofupgradingyourexistingOracleProductstothisrelease,or
implementingcompletelynewOracledevelopedproducts,andplanningyourI.T.Projects.
Disclaimer:
Thisdocumentinanyform,softwareorprintedmatter,containsproprietaryinformationthatistheexclusivepropertyofOracle.Youraccessto
anduseofthisconfidentialmaterialissubjecttothetermsandconditionsofyourOracleSoftwareLicenseandServiceAgreementorother
applicablecontractwithOracle,withwhichyouagreetocomply.Thisdocumentandinformationcontainedhereinmaynotbedisclosed,
copied,reproducedordistributedtoanyoneoutsideOraclewithoutOraclespriorwrittenconsent.Thisdocumentisnotpartofyourlicense
agreementnorcanitbeincorporatedintoanycontractualagreementwithOracleoritssubsidiariesoraffiliates.

Thisdocumentisintendedtooutlineourgeneralproductdirection.Itisintendedforinformationalpurposesonlyandsolelytoassistyouin
planningfortheimplementationandupgradeoftheproductfeaturesdescribed.Releaseinformationcontainedinthisdocumentisnotafirm
developmentplan.Releaseinformationpublishedhereshouldnotbeusedasthebasisforcustomerdeliverycommitments,aspartofmarketing
efforts,orduringcontractnegotiations.Thisisnotacommitmenttodeliveranymaterial,code,orfunctionality,andshouldnotberelieduponin
makingpurchasingdecisions.Thedevelopment,release,andtimingofanyfeaturesorfunctionality,andinclusionornotthereofinthe
commerciallyavailableversionoftheSoftware,ifany,issubjecttochangeatanytimeandisalwaysatOraclessolediscretion.Thisdocumentis
notconsideredpartoftheapplicableprogramdocumentation.

Duetothenatureoftheproductarchitecture,itmaynotbepossibletosafelyincludeallfeaturesdescribedinthisdocumentwithoutrisking
significantdestabilizationofthecode.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page2of112

GuideforHCMExtracts

DocumentControl
Change Record
Date

Author

Version

Change Reference

10-April-2012

0.1

First Release

04 July- 2012
29-Aug-2012

Ventrapragada Rajasekhar/ Parag


Jain/Shesha Shila Bharadwaj R
Parag Jain
Parag Jain

0.2
0.3

23-Oct-2012
16-Jan-2013
19-Mar-2013
21-Mar-2013
13-May-2013
0-June-2013

Ventrapragada Rajasekhar
Shesha Shila Bharadwaj R
Shesha Shila Bharadwaj R
Shesha Shila Bharadwaj R
Shesha Shila Bharadwaj R
Alison Firth

0/4
0/5
0/6
0/7
0/8
0/9

Details of Changes Only functionality


Note added for Delivery Option setup under sub-point-20 of Manage HCM
Extract Definition
Details on Copy and Export/Import functionality
Corrected Document and added Criteria Formula , Rollback
Added Section on Recursive Scheduling
Add Changes Only Attribute level features.
Added Generating DBI for flex fields
Edited guide for publication to MOS

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page3of112

GuideforHCMExtracts

Contents
Overview........................................................................................................................................................................................................................6
TasksrelatedtoExtracts:...........................................................................................................................................................................................7
Architecture...............................................................................................................................................................................................................8
CaseStudy:FastBankwantstosetupandrunHCMExtract........................................................................................................................................9
ManageHCMExtractDefinitions.................................................................................................................................................................................10
RefineHCMExtracts[OptionalSetup].........................................................................................................................................................................50
SubmitanHCMExtracts..............................................................................................................................................................................................55
SubmitanHCMExtractsRecursiveScheduling.....................................................................................................................................................62
ViewHCMProcess.......................................................................................................................................................................................................67
RollbackPayrollRun.....................................................................................................................................................................................................69
HowtodefineFastFormulae.......................................................................................................................................................................................70
SampleFormula.......................................................................................................................................................................................................74
HowtosetupChangesOnlydataextract...................................................................................................................................................................80
ChangesOnlyModes...............................................................................................................................................................................................81
GeneratingDBIforflexfields........................................................................................................................................................................................85
IntegrationwithBIPublisher.......................................................................................................................................................................................87
InstallingBIPublisherPlugin...................................................................................................................................................................................89
Definingthereport..................................................................................................................................................................................................93
Appendix....................................................................................................................................................................................................................106
Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page4of112

GuideforHCMExtracts

SampleScenarioofusingchangesonly(AttributeOnlymode)............................................................................................................................106

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page5of112

GuideforHCMExtracts

Overview
UseHCMExtractsforarchiving,reporting,andasanoutboundinterfacingtool.ThisdocumentincludesinformationonhowyoucanusetheHCMExtracttool
tocreateOutBoundinterfacing,orreporting.
TheDataExchangeworkareaallowsyoutoperformtasksrelatedtoInBoundandOutBoundinterfaces,whichallowsexchangeofdatabetweendifferentHR
systems.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page6of112

GuideforHCMExtracts

TasksrelatedtoExtracts:

ManageHCMExtractDefinitions
Definenewextracts,edit/modifyordeletetheexistingextracts
Extractdefinitioncontainsdetailsofwhatdatashouldbeextractedandthestructureinwhichdataneedstobeextracted,andhowthisdatashould
bedelivered(ftp,email,fax,etc)asformattedoutput(xls,csv,pdf,etc)usingBIpublisher

RefineHCMExtracts(optionalstep)
Whenwecreateanextract,theapplicationcreatesaflowpattern(i.e.checklist)automatically,whichincludesataskforexecutingtheextract.
Wecanrefinetheflowbyaddingpreorposttasksthatneedtobeexecutedalongwithdataextraction.

SubmitHCMProcess
Submittheextractforprocessingafterenteringtheparametervalues.Iftheextractdefinitioncontainsdeliveryoptionsthatspecifyanoutputformat
anddeliverymethod(email,ftp,etc),thentheoutputwillbegeneratedthroughtheintegrationwithBIPublisherapplication.

ViewHCMProcessResults(optionalstep)
ArchivedoutputstoredintablescanbeviewedatanytimethroughResultsUI.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page7of112

GuideforHCMExtracts

Architecture

Theextracteddataisretrievedfromthedatabase,throughdifferentmeans,forexample,FastFormula,BalanceGroupsandCustomLogicdefinedinPLSQLor
Javamethod.
AHCMExtractdefinitioncontainsrecords(groupingofattributes)thatcontainmultipledataelements(attributes).TheserecordsarearchivedbasedonFast
FormulaDatabaseItem(DBI)groups,orbasedonthestructureofthebalancegroup,orbasedonlogicdefinedinPLSQLorJavamethod.

TheextracteddataisarchivedintoresulttablesandstoredasanXMLoutputinthedatabase.ThisXMLoutputistransformedintoformattedoutputofHTML,
PDF,EFT,XLS,etcanddeliveredasemail,fax,ftp,print,etcbasedonthedeliveryoptionssetupfortheextract.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page8of112

GuideforHCMExtracts

CaseStudy:FastBankwantstosetupandrunHCMExtract
FASTBankisaglobalorganizationwithsubsidiariesallovertheworld.Itrequiresaheadcountreportwithdepartmentandemployeedetails.Theemployee
informationneedstobegroupedateachdepartmentlevel.TheyneedtodistributethisreportthroughFTPto3rdPartyasXML/Flatfile,andemailedtotheHR
manager.Togeneratethisreport,FASTBankmustdefineanextractandrunitusingtheHCMExtracttoolwithinFusionHCM.

FastBankExtractDesign
This Extract consists of 2 logical entities or blocks (i.e. Departments, Employees), which consists of few records in each block and different type of data
elements.

Blockrepresentsalogicalentity,whichcontainsSQLqueryforgettingdata,Forexample:Organizations,Persons,Employees,etc.
Block links allow you to define the parentchild relationship between the entities. For example: you can link Department and Employee blocks through
Department_ID.
Recordisacollectionoffields(dataelements)whichshouldbearchived/extracted.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page9of112

GuideforHCMExtracts

ManageHCMExtractDefinitions
1) ClickontheDataExchangeworkareatoperformtasksrelatedtoextracts.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page10of112

GuideforHCMExtracts

2) DataExchangeworkareahas4tasks(asmentionedabove)relatedtoHCMExtracts.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page11of112

GuideforHCMExtracts

3) ClickonManageHCMExtractDefinitions.
searchforexistingextractsandclickonNametoview/edit
orclickonCreatetodefineanewextract

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page12of112

GuideforHCMExtracts

4) Provideanamefortheextractdefinition,andselectthetypeofextractandsavethedefinition.
TheTagNamefieldisderivedanddefaultedautomaticallybasedontheextractnameyouenter(forallleveli.e.definition,parameters,blocks,records
anddataelements)andwillbeusedwhilegeneratingtheXMLoutput.

NOTE:ChangetheSessionEffectiveDatetoafixedvalue(forexample:01/01/2000)beforeyoucreateorupdateanydata.Entitiessuchascriteria,
records,dataelementsetc.dateeffectiveanddated,soincaseyouarecreating/editingtheextractsetupwithdifferentSessionEffectiveDatesthenthose
entitieswillgetcreatedwithdifferentdates.Thiswillcauseextractdefinitiontoproducenonuniformarchivefordifferentdates.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page13of112

GuideforHCMExtracts

5) Afteryousavetheextractdefinitionandbasedonthetypeofextractselected,theapplicationautomaticallycreatesanumberofparameters.Youcan
optionallyadd/edit/deleteadditionalparametersfromtheparameterstableregion.Theseparameterscanbeusedinthefilterconditions,calculationsor
extractedasdataelements.

6) ClickontheExtractBlockfolderonthelefthandsidenavigationtree.TheExtractBlocksregionopens.
ClickonCreatetodefineanewblock.
Ablockrepresentsalogicalentity,whichcontainsSQLqueryforfetchingdata,forexample,datasuchas:organizations,persons,employees.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page14of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page15of112

GuideforHCMExtracts

7) ProvidedetailsfortheblockandclickonSaveandCreateAnothertodefinethenextblock.
CreatealltheblocksneededforthisExtract.
MarkthestartingorparentblockfromwhereyouwanttheextractiontostartusingtheRootBlockoption.
UserEntity(LogicalEntity)isthenameofthequeryforfetchingtherequireddata,forexample,departmentsandemployees.

FrequentlyusedUserEntities:

Person:PER_EXT_SEC_PERSON_UE
o
o

Togetallpersonsacrosstheenterprise,and
Togetallpersonrelatedattributes):

Worker:PER_EXT_SEC_PERSON_UE

o Togetallworkersacrosstheenterprise,and
o Togetallperson,worker(relationship,term,assignment)relatedattributes
WorkerPayroll:PER_EXT_PAY_EMPLOYEES_UE
o Togetallworkersandtheirpayrollsacrosstheenterprise,and
o Togetallperson,worker(relationship,terms,assignment),payroll
(relationship,term,assignment)relatedattributesandElemententrydata

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page16of112

GuideforHCMExtracts

8) Createthesecondblockforthiscasestudy,andclickonSaveandClose.

9) OnceallblocksarecreatedthenclickonExtractBlockfolderinthenavigationtreetoviewExtractBlocks.
SelecteachchildblockrecordinExtractBlockstableanddefineBlockLinkdetails.
Blocklinksenableyoutodefinethemasterdetailofparentchildrelationshipbetweentheentities,forexample,employeeanddepartmentblocksare

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page17of112

GuideforHCMExtracts

linkedwithDepartment_ID.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page18of112

GuideforHCMExtracts

10) Onceallblocklinksaredefined,selecteachblockavailableundertheExtractBlockfolderanddefinethecriteriaandrecordsforeachblock.Usingthe
ExtractBlockCriteria,youcanspecifythefilterconditionsofwhatdatayouwanttoextract.Also,youcanspecifytheconditionsasanexpressionand/or
fastformula.Toaddblockcriteria;clickontheAddbuttonintheExtractBlockCriteriatable.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page19of112

GuideforHCMExtracts

11) YoucandefineblockcriteriaexpressionusingtheEditiconinCriteriaExpression.

BlockcriteriaexpressionistranslatedintoWHEREclauseofSELECTqueryandprovidesbetterperformancecomparedtocriteriaformula.
YoucancreateblockcriteriaformulausingtheManageFastFormulasUIandbyselectingtheExtractCriteriaformulatype.Theformulareturnsasingle
valuecalledeitherEXCLUDEorINCLUDE,hasavalueofTRUEorFALSEanddetermineswhethertoprocesstherecord.
MoredetailsonFastformulascanbefoundhere

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page20of112

GuideforHCMExtracts

12) CreateanextractrecordbyselectingtheCreatebuttonintheExtractRecordstableoftheExtractBlockdetailspage(screenshotstep9).
Anextractrecordisaphysicalcollectionoffields(dataelements)whichyouwanttoextract.
Providethefollowingdetails:thetypeofrecord(Header/Trailer/Details)andtheprocesstype:fastformula/balancegroup/customlogic.

Ifablockhas3records,thentheapplicationusesthesequencevaluetoidentifytheprocessingorder,andthenextblockvaluetoidentify
thenextblocktoprocess.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page21of112

GuideforHCMExtracts

13) SavingtherecordenablesyoutoselecttheCreatebuttonintheDataElementstable.
DataElementsaretheindividualfieldsinsidetherecord.Providethefollowingdetails:thetype(DBIgroup),rule,decodedelement,andthestring,and
therequiredfieldsbasedontheselectedtype.Therecordoutputisstoredinatablewith300columnsandthelocationofthisfieldiscapturedinthe
OutputColumnvalue.
ClickonSaveandCreateAnothertodefineallthedataelementsinthisrecord.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page22of112

GuideforHCMExtracts

DataelementswithDatabaseItemGroupasthetype(referboxabove)areassociatedwithafastformuladatabaseitemthatcorrespondstoSQLquery
forfetchingthefieldvalue(Forexample:OrganizationName,PersonFullName,JobName,etc.).

YoucanaddalltherequireddataelementsoftherecordoneindividuallyusingtheSaveandCreateAnotheroption.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page23of112

GuideforHCMExtracts

Youcanaddconditionalactionstorecordsanddataelementswithinarecord,thatspecifyanaction,suchas,logerrororwarning,tobeperformedwhen
theconditionisevaluatedastrue.Youcanspecifyaconditionasanexpressionorasfastformula.DefineformulausingManageFastFormulasUIwith
formulatypeasExtractAdvancedCondition,andreturnvalueofYorNforoutputvariableDO_ACTION.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page24of112

GuideforHCMExtracts

14) Onceallthedataelements(fields)ofrecordaredefined,thenyoucangenerateandcompiletheFastformulawhichcontainsthecodeforextractingthis
recorddata.

Note:AswellasusingtheCompileFormulaoptionyoucanalsodefinethecompleteextractandgeneratefastformulas.NotetheGeneratedFastFormula
names[asshowninabovescreenshot]andusetheNavigatormenuPayrollCalculationworkareaManageFastFormulasUISearchbygivingtheFormula
NameandLDG,edittheformulaandclickonCompileoption.MoredetailsonFastformulascanbefoundhere

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page25of112

GuideforHCMExtracts

15) Similarlydefineotherblocks,criteria,recordsanddataelements.
a.

BlockcriteriaforEmployeesblock

b.

CreaterecordswithintheEmployeesblock.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page26of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page27of112

GuideforHCMExtracts
c.

CreateadataelementforFullNamewithintheEmployeesblock.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page28of112

GuideforHCMExtracts
d.

CreateadataelementforDateofBirthwithintheEmployeesblock.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page29of112

GuideforHCMExtracts
e.

CreateadataelementforGenderwithintheEmployeesblock.YoucreatetheGenderdataelementasaDecodedDatabaseItemgroup,because
thistypeofelementallowsyoutodecodethevaluereturnedbytheDBIgroup.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page30of112

GuideforHCMExtracts
f.

CreateadataelementforSalarywithintheEmployeesblock.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page31of112

GuideforHCMExtracts
g.

CreateadataelementforBonuswithintheEmployeesblock.YoucreatetheBonusdataelementasaRecordcalculationtype,becausethistype
ofdataelementallowsyoutodefineanexpressionbasedonotherdataelementsandparameters.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page32of112

GuideforHCMExtracts
h.

CreateadataelementforTaxRatewithintheEmployeesblock.YoucreatetheTaxRatedataelementasaRuletype.Dataelementswithatype
valueofRule(refertothescreenshot)willbeassociatedwithfastformula.YoucandefinefastformulausingtheManageFastFormulasUIwith
formulatypeasExtractRule.Theformulacontainsthelogicforcalculatingthevalueyouwanttoextractfromthedataelement.

MoredetailsonFastformulascanbefoundhere

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page33of112

GuideforHCMExtracts
i.

ClickontheCreateoptionoftheExtractRecordstabletocreateadditionalrecordsintheDepartmentsBlock.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page34of112

GuideforHCMExtracts
j.

CreateanextractrecordforDepartmentSummarywithintheDepartmentsblock.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page35of112

GuideforHCMExtracts
k.

CreatedataelementswithintheDepartmentSummaryrecord.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page36of112

GuideforHCMExtracts
l.

CreatedataelementforRecordCodewithintheDepartmentSummaryrecord.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page37of112

GuideforHCMExtracts

m. CreatedataelementforReportDatewithintheDepartmentSummaryrecord.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page38of112

GuideforHCMExtracts
n.

CreatedataelementforEmployeeCountwithintheDepartmentSummaryrecord.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page39of112

GuideforHCMExtracts

16) Youcannavigatetoanyblockorrecordintheextractdefinitionbyclickingthelinksinthenavigationtree.Toviewthecompleteexecutiontree,selectthe
ExtractExecutionTreeoption.Thisactionvalidatestheextractdefinitionsetupandtheapplicationprovidesvalidationmessages,alongwithfastformula
compilationstatus.

ClickontheExporttoXSDbuttontodownloadtheXMLSchemaDefinition(.xsd)fileforthisextractsetup.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page40of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page41of112

GuideforHCMExtracts

YoucanviewtheexportedXSDthroughanybrowser.Thefilecontainsthestructureoftheextractdefinition,blocks,records,anddatadlements

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page42of112

GuideforHCMExtracts

17) Afterdefiningtheextract[setupandstructure]details,definetheformattingorlayoutoptionsusingBIPublisher.
MoredetailsonBIPublisherareavailablehere.
18) YoucandefinethedeliveryoptionsforanextractbyspecifyingtheBIpublishertemplate,deliveryfileoutputtype(PDF/XLS/XML/DOC)anddeliverymode
(FTP/email/fax).ThedeliverymodecanalsobeDocumentsofRecordwhichallowsyoutostoretheoutputinthedatabase(forexample,thisallows
employeestoviewonlinepayslipsfromdocumentsofrecord).
YoucanspecifyaburstingnodeifyouwanttosplitandbursttheXMLoutputintoseparatefiles.Forexample:ifyouwantallemployeestoreceivea
payslipasanemailthenyoucansettheburstingnodetoEmployee_ID.
Note:YoucanalsoviewtheformattedoutputdirectlyfromtheBIPublisher.

19) Basedonthetypeofdeliverymodeyouselect,youmayneedtoprovideadditionaldetails.Forexample,ifyouselectFTPasthedeliverytype,thenyou
mustprovidetheserver,usernameandpassworddetails.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page43of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page44of112

GuideforHCMExtracts

20) Oncealldeliveryoptionsaredefined,youcanassociatethemwithdifferentreportingcategories.

ImportantNoteforDeliveryOptionsSetup:
1.
2.

IntegrationofextractsandBIP(theabilitytoviewoutputdirectlyfromextractsUIratherthannavigatingtoBI)isavailableinRelease4.Thisallows
userstoviewtheoutputdirectlyaftertheextractprocessiscomplete.
SavetheBIreportinanyofthe'SharedFolders'locations(accessibletoalllogins),insteadofthe'MyFolders'location(accessibletotheloggedinuser
only).UsersonRelease3SaaSenvironmentsshouldcontacttheirBIadmintocreatetherequiredfolderstructure.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page45of112

GuideforHCMExtracts
3.

SpecifytheextractdeliveryoptionwiththeBIreportpathandtheprocesscanaccessthereportandshowtheoutputdirectlyfromtheUI.The
suggestedvaluesare:
a. Reportpath:/Custom/HumanCapitalManagement/ReportName.xdo
b. Templatename:LayoutnamegivenintheBIReport
c. Deliverytype:None

4.

RuntheextractandviewtheoutputthroughtheViewHCMProcess.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page46of112

GuideforHCMExtracts

CopyinganExtract
YoucanusetheCopyfacilitytomakecopyofanexistingextract.
Searchandselecttheextractthatyouwanttocopy,andclickontheCopybutton.
Specifythenewextractdefinitionname,andclickonOk.

Anewextractiscreatedanddisplayedinthesearchlist,(extractdefinitionincludingparameters,blocks,records,dataelementsarealsocopiedcopied).

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page47of112

GuideforHCMExtracts

Export/ImportofExtract
Youcancreateacopyofanexistingextractwithintheinstanceoracrossinstances(i.e.TesttoProductioninstanceinsteadofrecreatingthecomplete
extractmanually),thenyoucanusetheExportImportoption.

Searchandselecttheextractthatyouwanttoexport,andselecttheExportXSDFilebutton.
SelecttheSaveFileoptionandsaveittolocalfilesystem[completeextractdefinitionsetupinformationisdownloadedasXSDfile].

Selecttheinstancewhereyouwanttoexportthisextract,andselecttheImportXSDFilebutton.
Specifythenewextractdefinitionname,selectthelegislativedatagroupandtheXSDfileyoudownloadedearlier,andclickonOk.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page48of112

GuideforHCMExtracts

Theapplicationcreatesanewextractandyoucanquerytheextractfromthesearchregion.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page49of112

GuideforHCMExtracts

RefineHCMExtracts[OptionalSetup]
1) Afteryoudefineanextractaflowpatternisautomaticallycreatedwiththesamenameastheextract.Theflowpatternenablesyoutodefineanexecution
sequenceofmultipletasks,andenablesyoutoaddanypreorposttasksalongwithextractionofdata(defaulttaskthatiscreatedautomatically).
YoucanviewandmodifytheflowpatternusingtheRefineHCMExtractstask.YoucansearchforexistingflowpatternsandselectEdittoviewormodify.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page50of112

GuideforHCMExtracts

2) Youcanaddadditional(preorpost)tasks(ifneeded).

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page51of112

GuideforHCMExtracts

3) Youcanmodifythesequenceinwhichyouwanttoexecutethesetasks(ifneeded).

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page52of112

GuideforHCMExtracts

4) Youcandefineadditionalparameterstouseacrossmultipletasksintheflowpattern(ifneeded).
YoucanalsoeditparametersbyselectingtherequiredparameterrowandclickingontheEditIcon.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page53of112

GuideforHCMExtracts

5) WhenaParameteriscreatedinHCMExtractsSetupUIitisautomaticallyvisibleintheflowtorefine.Ifyouwanttoassociateacommonlookupwiththe
parameter,thenselecttherequiredparameter,andclickontheEditIcononthetopoftable.
SelectDisplayFormatandchooseLookupChoiceList.Inthelookupfieldprovidethecommonlookupcodeyouwanttodisplay.Thislookupisdisplayed
fortheparameterwhenyousubmittheprocess.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page54of112

GuideforHCMExtracts

SubmitanHCMExtracts
1) Aflowpatternwiththesamenameastheextractisautomaticallycreatedwhenyoudefineanextract.
YoucanruntheflowpatterndirectlyusingtheSubmitanHCMProcessoption.YoucanalsoaccessthistaskfromtheNavigatormenu>PayrollChecklist
workarea>SubmitaProcessorReport.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page55of112

GuideforHCMExtracts

2) Specifythenameforthecurrentflowrun(FlowInstance)andtheparametervalues,andselectNext.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page56of112

GuideforHCMExtracts

3) Ifthistaskisdependentonothertasksfromdifferentflowpatterns,thenyoucanspecifyinteractiondetails(Optional).

Forexample,ifyouwouldlikethistasktowaitbecauseanothertaskisrunning,thenselectNext.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page57of112

GuideforHCMExtracts

4) ReviewtheExtractandclickonSubmit.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page58of112

GuideforHCMExtracts

5) SelectOKorOKandViewChecklisttoviewtheprocessstatus.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page59of112

GuideforHCMExtracts

6) Ifyouselectedtoviewthechecklist,thenthestatusdisplays.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page60of112

GuideforHCMExtracts

7) ReviewtheStatuscolumn,ifthestatusdoesnotindicateagreentick,thenyoucanrefreshthestatusbyclickingontherefreshicon.Repeatthisprocess
untilthegreenticksappearagainstalltherows.Iftheprocesstakestoolong,thenyoucanquerythestatusofanyextractexecutedearlierbyusingthe
ViewanHCMProcessoption.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page61of112

GuideforHCMExtracts

SubmitanHCMExtractsRecursiveScheduling
Youcanselectthefollowingoptionsforrecursivescheduling:Daily,Weekly,andMonthly.Ifyouwanttocreateyourcustomschedule,youneed
tocreateaFastFormulaoftypeFlowSchedule.YoucancreateacustomschedulebycreatingafastformulawithFlowScheduleandreturn
whennextflowhastoberuni.egapindays.
UseCase:Yourequirerecursiveschedulingforevery5minutes.
Stepstofollow:
a) CreateafastformulawithFlowScheduleasthetype.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page62of112

GuideforHCMExtracts

b) Writeformulatoreturnnumberofdaysasgap.Inthiscasesincewerequire5minutes,return,((1/24)/60)*5daysasreturnvaluefor
flowscheduleformula.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page63of112

GuideforHCMExtracts

/*****************************************************************************
FORMULANAME:SampleFlowSchedule
FORMULATYPE:FlowSchedule
DESCRIPTION:Formulatoreturnadatetime.
ReturnsNEXT_SCHEDULED_DATE;
FormulaResults:
NEXT_SCHEDULED_DATEThiswillbeadatetimevaluewithyyyyMMddHH:mm:ssformat.
*******************************************************************************/

/*Inputs*/
INPUTSARESUBMISSION_DATE(DATE),SCHEDULED_DATE(DATE)

/*Calculations*/
NEXT_SCHEDULED_DATE=ADD_DAYS(SCHEDULED_DATE,0.00347)

/*Returns*/
RETURNNEXT_SCHEDULED_DATE

/*EndFormulaText*/

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page64of112

GuideforHCMExtracts

c) FollowsamestepstoSubmitHCMProcess,includingbelowvaluesinSchedulesection.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page65of112

GuideforHCMExtracts

d) Theinstanceisgeneratedevery5minutesfromwhentheprocessissubmitted.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page66of112

GuideforHCMExtracts

ViewHCMProcess
1) ViewHCMprocessallowsyoutoviewtheresultsofanextractrun.SearchforthedifferentrunsofextractbyenteringtheFlowPatternname.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page67of112

GuideforHCMExtracts

2) SelecttheflowinstancenametodisplaythestatuspageandselecttheGotoTaskicontoshowthereportoutput.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page68of112

GuideforHCMExtracts

RollbackPayrollRun
1) OpenPayrollChecklist>SubmitaProcessorReport,selecttheRollBackProcesstask.

2) EnterthePayrollFlownametoindicateittobeaRollbackruninstance.SelectthePayrollProcessLookupandselectthePayrollFloworInstancethatyou
wanttorollback.ThisPayrollFloworFlowInstancecanbeChangesOnlyrunalso.SubmittheflowandselecttheOkandViewChecklistoption.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page69of112

GuideforHCMExtracts

HowtodefineFastFormulae
YoucanlaunchtheManageFastFormulasUIfromtheNavigatorMenuPayrollCalculationworkarea>ClickingontaskManageFastFormulas.
Thefollowingtableliststhedifferenttypesofformulayoucanuseforextracts:
FormulaType
ExtractCriteria

Description
FormulasofthistypewillbelistedintheBlockCriteriaFastformulalist,canbeusedforspecifyingcomplexcriteriawhichindicatesif
recordshouldbeextractedornot
ExtractRule
FormulasofthistypewillbelistedintheRuletypeDataElementsFastformulaslistcanbeusedforderiving/calculatingdataelementvalue
ifitisbasedoncomplexlogicorbusinessrules
ExtractAdvanced FormulasofthistypewillbelistedintheRecord/DataElementAdvancedconditionsFastformulaslist canbeusedforspecifyingcomplex
Condition
conditionswhichindicatesifactions(eg:logerror/warning)shouldberaised.
ExtractRecord
Formulasofthistypewillbegenerated automaticallywhenusingGenerateFormulaoptioninExtractRecords

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page70of112

GuideforHCMExtracts

1) Youcanquery/view/edit/createformulasfromthisUI.Fastformulacancontainanycomplexbusinesslogic,andyoucanuseitalongwithextracts.

2) EntertherelevantfastformuladetailsandselecttheContinuebutton.EntertheformulatextintheManageFormuladetailspage.

[SampleExtractRuleformulatextisgivenbelow]

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page71of112

GuideforHCMExtracts

.
ExtractRuleformulashouldhavevaluereturnedthroughvariableRULE_VALUE

Similarlyextractcriteria(blockcriteria)formulashouldhavevaluereturnedthroughvariableINCLUDE/EXCLUDEandreturnvalueasTRUE/FALSE.

[SampleExtractCriteriaformulatextisgivenbelow]

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page72of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page73of112

GuideforHCMExtracts

SampleFormula

BlockCriteriaFormula:
1)SampleBlockCriteriaFormulatofilterbasedonruntimeDepartmentName.
a)CreateExtractParameteroftexttype,withnameDEP_NAME.
b)FormulatofilterbasedonruntimeDEP_NAME
DEFAULTFORPER_ASG_ORG_NAMEIS''
dept_name_from_dbi=PER_ASG_ORG_NAME
dept_name_from_param=GET_PARAMETER_VALUE('DEP_NAME')
IFdept_name_from_dbi=dept_name_from_paramTHEN(
INCLUDE='TRUE'
)ELSE(
INCLUDE='FALSE'
)
returnINCLUDE
===
2)SampleBlockCriteriaFormulatofilterbasedonruntimeRelationshipAttribute1.
Usecase:HerePeriodsofServicecustomerflexstoresPayrollProviderinATTRIBUTE1.
a)CreateExtractParameteroftexttype,withname'ProviderName'andEssParameternameas'Provider_Name'.
b)FormulatofilterbasedonruntimeDEP_NAME
DEFAULTFORPER_REL_ATTRIBUTE1IS''
rel_attribute1_from_dbi=PER_REL_ATTRIBUTE1
provider_param=GET_PARAMETER_VALUE('Provider_Name')
IFrel_attribute1_from_dbi=provider_paramTHEN(
INCLUDE='TRUE'
Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page74of112

GuideforHCMExtracts

)ELSE(
INCLUDE='FALSE'
)
returnINCLUDE
Inthescenariosabove,thereisaknownissueifPayrollProviderNameorDepartmentNamehasaspace.Ensurethatyoutruncatethe
parameteruntilfirstspace;otherwisetheresultsmighthaveadifferentoutput.Thefollowingbugneedstobefixedtoresolvetheissue.
BUG15921815RUP3MAINTAINANCE:SPACEISNOTWORKINGPARAMETERS,UNABLETOGETSENTENCES
3)BlockCriteriaFormulatodealwithMultiRowData.
DEFAULTFOR"PER_EXT_CONT_CONTACT_TYPE"IS''
INPUTSARE"PER_EXT_CONT_CONTACT_TYPE"(text)

INCLUDE='FALSE'

IF("PER_EXT_CONT_CONTACT_TYPE"='M')THEN(
INCLUDE='TRUE'
)

RETURNINCLUDE

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page75of112

GuideforHCMExtracts

RuletypeFormula:

1) Usecase:GetPrimaryNIDofContact
GetContactPersonIdviaDataElement,setPERSON_IDcontexttoContactPersonId,GetDBIValueofPrimaryNIDtogetNIDofcontact
effectively.Bythiswayyoucangetanyinformationrelatedtocontact.
a)Createadataelementwithdbias'ExtractContactPersonId,withshortcodeas'CONTPID'.

b)Createa'ExtractRule'TypeFormula(CONTACT_NID_FF)withthefollowingtext:

DEFAULTFORDATA_ELEMENTSISEMPTY_TEXT_TEXT

DEFAULTFORPER_PER_PRIMARY_NID_NUMBERIS''

INPUTSAREDATA_ELEMENTS(TEXT_TEXT)

X=DATA_ELEMENTS['CONTPID']

CHANGE_CONTEXTS(PERSON_ID=TO_NUMBER(X))
(
RULE_VALUE=PER_PER_PRIMARY_NID_NUMBER
)

RETURNRULE_VALUE

c)CreateRuletypedataelement(withName:ContactNID)assiblingofdataelementcreatedin(1).
AssociateCONTACT_NID_FFasfastformula.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page76of112

GuideforHCMExtracts

2) Usecase:GetContactFullName
GetContactPersonIdviaDataElement,setPERSON_IDcontexttoContactPersonId,GetDBIValueofPersonLocalNametogetLocalNameof
contacteffectively.Bythiswayyoucangetanyinformationrelatedtocontact.
a)CreateadataelementwithDBIas'ExtractContactPersonId,withshortcodeas'CONTPID'.

b)Createa'ExtractRule'TypeFormula(CONTACT_LOCNAME_FF)withthefollowingtext:

DEFAULTFORDATA_ELEMENTSISEMPTY_TEXT_TEXT

DEFAULTFORPER_PERSON_LOCAL_FULL_NAMEIS''

INPUTSAREDATA_ELEMENTS(TEXT_TEXT)

X=DATA_ELEMENTS['CONTPID']

CHANGE_CONTEXTS(PERSON_ID=TO_NUMBER(X))
(
RULE_VALUE=PER_PERSON_LOCAL_FULL_NAME
)

RETURNRULE_VALUE

c)CreateRuletypedataelement(withName:ContactLocalFullName)assiblingofdataelementcreatedin(1).
AssociateCONTACT_LOCNAME_FFasfastformula

3) UseCase:UsingPredefinedFormulaFunctions.
Youcangetavailabilitydetailsofapersonusingpredefinedfastformulafunctionbetweenastartdateandanenddate.
DEFAULTFORDATA_ELEMENTSISEMPTY_TEXT_TEXT
INPUTSAREDATA_ELEMENTS(TEXT_TEXT)
Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page77of112

GuideforHCMExtracts

SDATE=TO_DATE(SUBSTR(TRANSLATE(DATA_ELEMENTS['StartDate'],
'01234567890:.TZ','01234567890:.'),1,19),'YYYYMMDD
HH24:MI:SS')
EDATE=TO_DATE(SUBSTR(TRANSLATE(DATA_ELEMENTS['EndDate'],
'01234567890:.TZ','01234567890:.'),1,19),'YYYYMMDD
HH24:MI:SS')

RULE_VALUE=to_char(GET_PAY_AVAILABILITY('ASSIGN',SDATE,EDATE,'Y','Y','N','N','H'))
RETURNRULE_VALUE

4) UseCase:WorkingwithArrayDBIs
GetallContactNames,commaappendedassingleitem.
CreatearootblockwithAssignmentUserentity,whichsetscontextofPersonId.PER_EXT_CONT_FIRST_NAMEwillreturnyouarrayof
contactnamesassociatedwiththeperson.
CreateaRuleElementwiththefollowingcodeandassociateitwithadataelement(ContactNames)inrootblock.
DEFAULT_DATA_VALUEforPER_EXT_CONT_FIRST_NAMEIS''

I=1
N=''
WHILEPER_EXT_CONT_FIRST_NAME.EXISTS(I)LOOP
(
IFI<>1THEN
(
N=N||','
)
N=N||PER_EXT_CONT_FIRST_NAME[I]

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page78of112

GuideforHCMExtracts

I=I+1
)
RULE_VALUE=N
RETURNRULE_VALUE

5) UseCase:Usinglooptoiterateandgetvalue
Youcangetthelastterminationdateofanemployee.

DEFAULT_DATA_VALUEforPER_HIST_ASG_REL_ACTUAL_TERM_DATEIS'01JAN0001'
(DATE)

I=1
MAXTDATE='01JAN0001'(date)
@DEFAULTDATE='01JAN0001'(date)

WHILEPER_HIST_ASG_REL_ACTUAL_TERM_DATE.EXISTS(I)LOOP
(

IF(PER_HIST_ASG_REL_ACTUAL_TERM_DATE[I]>MAXTDATE)THEN(
MAXTDATE=PER_HIST_ASG_REL_ACTUAL_TERM_DATE[I]
)
I=I+1
)

IF(MAXTDATE=DEFAULTDATE)THEN(
RULE_VALUE=''
)ELSE(
RULE_VALUE=TO_CHAR(MAXTDATE,'YYYY/MM/DD')
)

RETURNRULE_VALUE

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page79of112

GuideforHCMExtracts

HowtosetupChangesOnlydataextract
1) Navigatetotheextractdefinition,andaddanextractparametercalledChangesOnlybyclickingonAddbutton.Note:YoumustenterthevalueofESS
ParameterasCHANGES_ONLYinuppercaseswithoutanyspellingmistakes.

2) Setupmultithreadingdatabaseiteminanyoneoftheblocks.
IfyouarechoosingPAYROLL_RELATIONSHIP_IDequivalentDBIasthethreadingdatabaseitem(presentinuserentity),thenyouneedtoselectthe
threadingactiontypeas"Relationshipactions".IfyouarechoosinganyuniqueDBIitemotherthanPayrollRelationshipId,thenyoucanuseObject
Actions.
Forexample:ifyouselectthePER_EXT_PAY_EMPLOYEES_UEuserentity,thenyoucanhavethreadingdatabaseitemas
PER_EXT_PAY_HR_ASSIGNMENT_IDandthreadingactiontypeas'ObjectActions'.

Note:Thisstepshouldbeperformedforanewextractblockonly.Youcannotmodifyexistingextractblockstoaddathreadingdatabaseitem.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page80of112

GuideforHCMExtracts

3) RuntheExtractDefinitionwithCHANGES_ONLY='N'now,sothatitproducesXMLwithcompletedata.
4) RuntheextractwithCHANGES_ONLY='Y'tofetchthedatathathasbeencorrectedorupdatedsincethelastrunonly.Ifanydatachangesareobserved
fromapreviousrun,thenthosechangeswouldreflectinthegeneratedXMLonly.

ChangesOnlyModes
TherearefourmodesforChangesOnly.ChangesOnlyModes(c),(d)mentionedbelowwillonlyworkfromREL5onwards.
a)

FullExtract(N:No,displayfulldetails)
IfyourunanextractwithChangesOnlyvalueasN,thenitwouldbeafullextract,and,thereforeentiredatawouldbeextractedinthesystem.
GenerallyyouneedtorunextractasNforfirsttimeandthereafterchooseothermodesofChangesOnly.

b) ChangesOnlyatblocklevel(Y:Yes,displayalldetails)
IfyourunanextractwithChangesOnlyvalueasY,onlydatathathaschangedfromapreviousrunwouldbeextracted.Inthiscase,evenifasingle
attributeischanged,entireattributesoftheblockwouldbeextracted(evenifotherattributesarenotchanged).
c)

ChangesOnlywithattributelevelchanges(ATTRIBUTE:Yes,displaynewandmandatorydetails)
IfyourunanextractwithChangesOnlyasATTRIBUTE,theextractwouldreturnallchangesfromapreviousrunandonlyattributeswhichare
changedwillbeextracted.
Forthismodetowork,youmustperformafewextrastepswhiledefiningdataelements.
Step1:
Foreachblockdefinedintheextract,youmusthighlightatleastonedataelementintheblockasaKeyDataElement.Thedataelementyouchoose
mustbeunique(forexample:AssignmentId,PersonId,PersonNumber,CitizenshipId,VisaId,PhoneId).Itwouldbeideallyprimarykeyfortheuser
entityyouarechoosing.Forexample:forAssignmentandPayEmployeeUserEntityitwouldbeAssignmentIdandforPersonUserEntityitwouldbe
PersonId.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page81of112

GuideforHCMExtracts

Step2:
ForeachblockyoudefineinanExtract,highlightatleastonedataelementasChangedDataElement.Thedataelementyouchooseshouldbean
attributewhichalwaysdisplaysandwillbeusedtoidentifytherecordforwhichdatahaschanged.Forexample,PersonNumber,PersonNameisthe
attributewhichwillberequiredtoidentifywhoserecordhaschanged.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page82of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page83of112

GuideforHCMExtracts

d) ChangesOnlywithattributechangesandoldvalues(ATTRIB_OLD:Yes,displaynew,old,mandatorydetails)
IfyouprovidevalueofChangesOnlyasATTRIB_OLD,thisoptionextractsonlyattributeschangedfromapreviousrunalongwithitsoldandnew
value.Youneedtoperformthesamestepsasin(c)forthismodetowork.

SampleXMLOutputwithATTRIBUTEchanges:

AsamplescenarioofattributelevelchangesisprovidedintheAppendixsection.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page84of112

GuideforHCMExtracts

GeneratingDBIforflexfields
TheGenerateDatabaseItemsprocessallowsyoutogenerateDBIfortheflexfieldsassociatedwithparticularcontext.
Navigator>PayrollChecklist
Selectthe'SubmitaProcessorReport'option.
SearchandselectforGenerateDatabaseItems.
ProvideauniquefreetextvalueforthePayrollFlowfield.
ProvideavalidDDForEFFnamefor'Name'andvalidcontextrelatedtotheEFFtypedinfor'Context'.

Singlerowcontextsaresupportedandforfollowingfrequentlyusedflexfields.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page85of112

GuideforHCMExtracts

PER_ORGANIZATION_INFORMATION_EFF,PER_ACCRUAL_PLAN_LEG_DDF,PER_ASG_LEG_DDF,PER_ASSIGNMENT_EIT_EFF,PER_JOBS_EIT_EFF,
PER_JOBS_LEG_EFF,PER_LOCATION_INFORMATION_EFF,PER_LOCATION_LEG_EFF,PER_PERSON_EIT_EFF,PER_PERSON_LEGISLATIVE_DATA_LEG_DDF,
PER_PERSON_NAME_LEG_DDF,PER_POSITIONS_EIT_EFF,PER_POSITIONS_LEG_EFF,PER_PPS_LEG_DDF
Supportformultirowcontextassociatedwithflexfieldistrackedthoughfollowingenhancement:
Bug16737421NEEDSUPPORTFORGENERATIONOFMULTROWFLEXDBI

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page86of112

GuideforHCMExtracts

IntegrationwithBIPublisher
YoucanlaunchBIpublisherfromtheNavigatormenuReportsandAnalyticsworkarea.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page87of112

GuideforHCMExtracts

ClickontheBrowseCatalogoptiontoopentheBIPublisherEnterprise.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page88of112

GuideforHCMExtracts

InstallingBIPublisherPlugin

TemplateBuilderforWordisapluginavailablefromBIPublisherEnterpriseHomepageoryoucandownloaditfromOraclelink.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page89of112

GuideforHCMExtracts

ThisPluginprovidessampledocuments,demos,templatesandTemplateViewer.Thesewillhelpyouunderstandtheconceptsandalsocreatetemplates
(EFT,RTF,etc.)toviewformattedoutputofXML.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page90of112

GuideforHCMExtracts

AfterinstallingtheBIPublisherpluginforMSWord,youcanfindtheOracleBIPublisheroptionintheAddInstab.UsetheAddinsoptiontoloadthe
structureofdata(XSD)usingLoadXMLSchemaoption.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page91of112

GuideforHCMExtracts

AftertheLoadXMLSchemaiscomplete,youcanarrangefieldsintherequiredlayoutandformat,anduploadthetemplatetoBIPublisherasmentioned
below.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page92of112

GuideforHCMExtracts

Definingthereport
ReportwillbebasedonaBIPublisherDataModel.
Youcanusetheexistingstandarddatamodelavailableatthisfolderlocation:/HumanCapitalManagement/Payroll/Data
Models/globalReportsDataModel.

ThisdatamodelcontainsSQLquerytogetXMLoutputtakingflowinstancerunnameasparameter.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page93of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page94of112

GuideforHCMExtracts

ClickonSavetosavethereport.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page95of112

GuideforHCMExtracts

Therearemanyoptionsavailablefordefiningthelayoutsofareport.
Basedontemplateuploaded,whichcanbebasedonRTF,PDF,etc.createdusingMSWordplugin
BasedonBasicTemplatesandinbuiltlayouteditoravailableinBIPublisherEnterprise
Basedontemplategenerateautomaticallybasedonselecteddatamodel.

YoucanuploadtheearlierdefinedBIpublisherRTFtemplate,andtestthelayoutbyclickingonViewReportandyoucanviewtheoutputintherequired
fileformat.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page96of112

GuideforHCMExtracts

ThecontentsoftheReportLayoutaredisplayedbelow.ThisreportcanbedownloadedasapdffilebyclickingonthePDFoption.
LatestdatamodelwillhaveflowinstancenameparameteralsoalongwiththePayrollActionID.Flowinstancenamewillbethenameoftheflowpattern
rungivenearlierwhensubmittingtheextract.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page97of112

GuideforHCMExtracts

APDFfileisgeneratedanddisplayedinanewwindow.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page98of112

GuideforHCMExtracts

Similarlyyoucanuploadothertemplates(forEFTElectronicFileTransfer)bydefiningthelayoutinMSWord.
YoucanusetheEFTtemplateforgeneratingthefixedlengthdelimitedtextfiles.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page99of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page100of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page101of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page102of112

GuideforHCMExtracts

YoumustuploadtheEFTtemplatesastypeeTextTemplate

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page103of112

GuideforHCMExtracts

TestthelayoutbyclickingonViewReportandviewtheoutputintherequiredfileformat.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page104of112

GuideforHCMExtracts

TwotabsReportLayoutandEFTLayoutaredisplayed.

LatestdatamodelwillhaveflowinstancenameparameteralsoalongwiththePayrollActionID.Flowinstancenamewillbethenameoftheflowpattern
rungivenearlierwhensubmittingtheextract.
ContentsofEFTLayoutisdisplayedbelow.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page105of112

GuideforHCMExtracts

Appendix
SampleScenarioofusingchangesonly(AttributeOnlymode)
Createextractdefinitionwithtwoblocks(parentandchild),createEmployeeblock(usingPER_EXT_SEC_PERSON_UE)asrootandchild
EmployeeContactsBlock(usingPER_EXT_CONTACT_RELATIONSHIPS_UE)andjointhetwoblockswithablocklinkasdisplayedbelow.
Followallthestepsrequiredforbasicchangesonlyfunctionality,providethemultithreadingDBIandactionasrequiredforrootblockand
creatingChangesOnlyparameter.

Createarecordinrootblock(Employeeblock>EmployeeBasicDetails)andtherecordshouldcontainsdataelementwhichhastobeaprimary
key(inthiscaseitisEmployeePersonId).
Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page106of112

GuideforHCMExtracts

HighlightthePersonIdaskeyandalsomarkthemandatoryfieldswhichyouwanttodisplayirrespectiveofwhetheritischangedornotas
Changedinthedataelementcreation.

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page107of112

GuideforHCMExtracts

Eveninthechildblockrecord(EmployeeContactblock>ContactDetails),createprimarykeydataelementinthiscaseitisContactPersonId.
AlsomarkthefieldsthatyouwanttodisplayirrespectiveofwhetheritischangedornotasChangedinthedataelementcreation(likePerson
Number).

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page108of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page109of112

GuideforHCMExtracts

RunningtheHCMExtract:
RuntheextractwithchangesonlyparameterasNtofetchthefullextract.

Nowchangeanyvalueofagivenemployeeandruntheextractwithchangesonly=ATTRIBUTE,thenyoucanseeonlyattributesthatare
changedandthefieldswhicharemandatory(markedaschanged).

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page110of112

GuideforHCMExtracts

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page111of112

GuideforHCMExtracts

Output

Copyright 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential.

Page112of112