Roam Bi Enterprise Tal End Components

RoambiEnterpriseTalendComponentsMay2016
Roambi Enterprise
Talend Components
1
TableofContents
I.Overview
Introduction
II.Setup
Requirements
RoambiRequirements
TalendRequirements
RoambiConfiguration
CreatingAPIKey
TalendConfiguration
SettingupRoambiScript
SettingupRoambiTalendComponents
III.HowtoUse
tRoambiUpdate
tRoambiMultipleUpdates
tRoambiPublishWithFile
tRoambiMultiplePublishWithFile
IV.UseCases
PublishingmultiplefilesusingthetFlowToIteratecomponent
PublishingmultiplefilesusingthetFlowToIteratecomponentandSendEmailNotification
forErrors.
PublishingmultiplefilesusingthetFlowToIteratecomponent,RetryincaseofErrorand
SendEmailNotificationforErrors.
AppendixA:TroubleshootingandCommonIssues
2
I. Overview
Introduction
TheRoambiEnterpriseTalendComponentssimplifiestheprocessofupdatingaRoambireport
withdatapreparedbyTalendETLtool.
WiththenewRoambiTalendcomponents,aTalendusercanaggregatedatafromavarietyof
datasourcesincludingSalesforce,databases,webservices,andpreparethemforRoambi
Analyticscreation.WithTalend,theentireprocessofdatacollection,preparation,andcreation
ofRoambicanbeautomated.
FordetailedinformationaboutTalend:
https://www.talend.com/products/dataintegration
DownloadTalendOpenStudioandDocumentation:
https://www.talend.com/download/talendopenstudio?qtproduct_tos_download=3
3
II. Setup
Requirements
Roambi Requirements
1. CreatedaRoambiView tobeusedasatemplate.
2. AdministratoraccesstoRoambiEnterprise.
3. RoambiEnterpriseAPIClientKey.
4. InstallandconfigureRoambiScript.
5. RoambiUsersinvitedintoAccount.
Talend Requirements
1. TalendOpenStudio,orotherTalendDataIntegrationoffering
2. InstallRoambiEnterpriseTalendComponents
Roambi Configuration
TheRoambiEnterpriseTalendComponentsenablesuserstouploadfiletoRoambiFileSystem
oruseanexistingRoambireportastemplatetocreatepersonalizedRoambireportstoyour
recipients.IfyouhavenotcreatedaRoambiReport,pleasereviewour gettingstartedmaterial
andselectaRoambiView tocreateyourfirstreport.
WhencreatingaRoambireportasatemplate,thegeneralworkflowis:
1. Determinethedatatobesharedwithyourrecipients.Decideifallrecipientswillgetthe
samedataoritwillbefilteredbyspecificcategory,product,orcountry.
2. Createasampledatafileasatemplate.
3. UploadtoRoambiEnterpriseandcreateyourRoambireport.
4. ReviewandrefinetheRoambiView.
Aswithalldesignprocesses,creatingaRoambireportwilltakefewiterationsandpractice.
Generalrecommendationistoworkthroughthestepsoutlinedhere,andgetearlyfeedback
fromrecipientsbeforeinvestingonperfectingthesmallerdetails.
Creating API Key
4
TheRoambiEnterpriseTalendComponentsleveragestheRoambiAPItofacilitatethecreation
ofRoambireports.NoprogrammingorAPIknowledgeisrequiredtousethecomponents,but
theyoudoneedtoregisteranAPIclient.
TosetupanAPIclientpleasefollowthestepsoutlinedintheknowledgebasearticle HowdoI
createaRoambiAPIclient?
PleasekeepthedetailsoftheAPIclientreadilyavailable,asitwillbeusedinthenextsection.
Talend Configuration
ToenabletheRoambiEnterpriseTalendComponents,itrequiresthefollowingtwosteps:
SettingupRoambiScript APIutilitythatTalendComponentswillusetocommunicate
toRoambiEnterprise.
AddingTalendComponents PackagefiletobeaddedtoTalendComponentlist.
5
Setting up RoambiScript
1. DownloadRoambiScriptfrom SAPServiceMarketplace .Createafolderthatcanbe

easilyreferenced.Inthisdocumentation,RoambiScriptisinstalledin
C:\roambiscript
folder.

2. Runroambiscriptconfigure intheterminaltogenerateapropertiesfile.

javajarroambiapicli.jarconfigure

3. Afterexecutingtheabovecommand,itwillcreatearoambiapi.cli.properties file.

NoteyouwillberequiredtoentertheAPIclientdetailsyoupreviouslycreatedin
CreatingAPIKey.ThiswillensurethatthisAPIutilityisprovisionedtotalktoyour
RoambiEnterpriseorganization.

Additionally,pleasenotetheRoambiScriptinstallationpath(inthisexampleitis
C:\roambiscript).Thecomponentswillneedtoreferencethisdirectorypath.
Setting up Roambi Talend Components
1. IdentifytheusercomponentsfolderofyourTalendinstallation.Forthis,openTalend
OpenStudioandclickonWindowmenuandthenonPreferencesoption.Onthe
Preferenceswindow,navigatetoTalend>Componentsandyouwillseethecurrent
Usercomponentfolderproperty.Ifthispropertyisnotset,thencreateafolderwhere
youwillinstallallyourusercomponentsandsetthispropertyaccordingly.
6
2. DownloadtheTalendRoambiComponentzipfile(roambitalendcomponents.zip)and
copyittosometempfolder.
3. CopythefolderstRoambiUpdate,tRoambiMultipleUpdates,tRoambiPublishWithFileand
tRoambiMultiplePublishWithFiletotheTalendusercomponentsfolder.
4. CloseandreopenTalendOpenStudio.NowyoushouldseethenewRoambi
componentsonthepaletteunderCloud>Roambicategory.
7
8
III. How to Use

WehavecreatedfouroutputtalendcomponentstRoambiUpdate,tRoambiMultipleUpdates,
tRoambiPublishWithFileandtRoambiMultiplePublishWithFile,thatyoucanusewhencreating
yourTalendjobs.
tRoambiUpdate
Thiscomponentuploadsthegivensourcefile(excelorcsvfile)toRoambiFileSystem(RFS).If
thefilealreadyexistsinRFS,itreplacesit.
ThesourcefilecanbecreatedwiththebuiltintFileOutputExcelortFileOutputDelimitedTalend
components.YoucanconnectthosecomponentstothetRoambiUpdatecomponent.
TheparametersofthetRoambiUpdatecomponentare:
Roambiscriptconfigfile:
Pathtotheroambiapi.cli.properties
file.Thisfilecontainsthesettingsto
connecttoRoambi.ThecreationofthisfilewasexplainedaboveintheSetting
upRoambiScriptsection.
9
SourceFile(excelorcsvfile):
Pathtothelocalsourcefile.
DestinationFolder:
FolderinRFSwherethefilewillbeuploaded.
Title:
NameofthenewfileinRFS.
Permissions:(Deprecated.UseUsersandGroupsparameters)
Roambiusersand/orgroupstograntaccesstothefile.Usesemicolonto
separatemultipleusersandgroups.i.e.
mauricio@mellmo.comdaniel@mellmo.comSalesGroup.

Users:
Roambiuserstograntaccesstothefile.Usesemicolontoseparatemultiple
users.i.e.mauricio@mellmo.comdaniel@mellmo.com.
Groups:
Roambigroupstograntaccesstothefile.Usesemicolontoseparatemultiple
groups.i.e.SalesGroup.
tRoambiMultipleUpdates
Thiscomponentuploadsmultiplesourcefiles(excelorcsvfiles)toRoambiFileSystem(RFS).
IfafilealreadyexistsinRFS,itreplacesit.
ThesourcefilescanbecreatedwiththebuiltintFileOutputExcelortFileOutputDelimitedTalend
components.Youcanuseasubjobtogeneratethosefilesandthentriggertheexecutionofthe
tRoambiMultipleUpdatescomponentwhenthesubjobcompletes.
10
TheparametersofthetRoambiMultipleUpdatescomponentare:
Pathtothe
roambiapi.cli.properties file.Thisfilecontainsthesettingsto

MappingTable:
TabletomapeachsourcefilewithitsdestinationinRFS.Thefieldsinthistable
are:
11
DestinationFolder:
FolderinRFSwherethefilewillbeuploaded.
Title:
NameofthenewfileinRFS.
Permissions:(Deprecated.UseUsersandGroupsfields)
Roambiusersand/orgroupstograntaccesstothefile.Usesemicolonto
separatemultipleusersandgroups.i.e.

Users:
Roambiuserstograntaccesstothefile.Usesemicolontoseparate
multipleusers.i.e.mauricio@mellmo.comdaniel@mellmo.com.

Groups:
Roambigroupstograntaccesstothefile.Usesemicolontoseparate
multiplegroups.i.e.SalesGroup.

tRoambiPublishWithFile
ThiscomponentpublishesaRoambifilewiththegivensourcefile(excelorcsv)andthegiven
Roambitemplate.IftheRoambifilealreadyexistsinRFS,itrefreshesit.
components.YoucanconnectthosecomponentstothetRoambiPublishWithFilecomponent.
12
TheparametersofthetRoambiPublishWithFilecomponentare:
Template:
FullpathtotheRoambitemplatefileinRFS.

13
DestinationFolder:
Thisparameterisoptional.ItisthefolderinRFSwheretheRoambifilewillbe
published.Ifitisnotspecified,theRoambifilewillbecreatedintheMy
DocumentsfolderoftheRoambiusersgiveninthePermissionsparameter.
RoambiFileName:
NameoftheRoambifilethatwillbegenerated.
Permissions:(Deprecated.UseUsersandGroupsparameters)
Roambiusersand/orgroups.Thoseusersandgroupswillhavethepermissionto
openthegeneratedRoambifile.Usesemicolontoseparatemultipleusersand
groups.i.e.mauricio@mellmo.comdaniel@mellmo.comSalesGroup.
Users:
Roambiusers.Thoseuserswillhavethepermissiontoopenthegenerated
Roambifile.Usesemicolontoseparatemultipleusers.i.e.
mauricio@mellmo.comdaniel@mellmo.com.

Groups:
Roambigroups.Thosegroupswillhavethepermissiontoopenthegenerated
Roambifile.Usesemicolontoseparatemultiplegroups.i.e.SalesGroup.
tRoambiMultiplePublishWithFile
ThiscomponentpublishesmultipleRoambifilesfromdifferentsourcefiles(excelorcsv)and
Roambitemplates.IfaRoambifilealreadyexistsinRFS,itrefreshesit.
components.Youcanuseasubjobtogeneratethosefilesandthentriggertheexecutionofthe
tRoambiMultiplePublishWithFilecomponentwhenthesubjobcompletes.
14
TheparametersofthetRoambiMultiplePublishWithFilecomponentare:
MappingTable:
TabletomapeachsourcefilewithitsRoambifileinRFS.Thefieldsinthistable
are:
15
Template:
FullpathtotheRoambitemplatefileinRFS.

DestinationFolder:
Thisparameterisoptional.ItisthefolderinRFSwheretheRoambifile
willbepublished.Ifitisnotspecified,theRoambifilewillbecreatedinthe
MyDocumentsfolderoftheRoambiusersgiveninthePermissions
parameter.
RoambiFileName:
NameoftheRoambifilethatwillbegenerated.
Permissions:(Deprecated.UseUsersandGroupsfields)
Roambiusersand/orgroups.Thoseusersandgroupswillhavethe
permissiontoopenthegeneratedRoambifile.Usesemicolontoseparate
multipleusersandgroups.i.e.
Users:
Roambiusers.Thoseuserswillhavethepermissiontoopenthe
generatedRoambifile.Usesemicolontoseparatemultipleusers.i.e.
mauricio@mellmo.comdaniel@mellmo.com.
Groups:
Roambigroups.Thosegroupswillhavethepermissiontoopenthe
generatedRoambifile.Usesemicolontoseparatemultiplegroups.i.e.
SalesGroup.
IV. Use Cases
Publishing multiple files using the tFlowToIterate component
tRoambiPublishWithFilepublishesoneroambifilebasedonthegivensourcefile,template,
destinationfolderandpermissions(usersandgroups).Ifyouwanttopublishmultipleroambi
files,youmayhavethismappinginformationinatablestoredinadatabaseorinaCSVfile.
16
ForexampleyoucanhaveaCSVfilecalledmappingTable.csv,with6columns:sourcefile,
template,destinationfolder,roambifilename,usersandgroups.Thisisanexample:
Youwanttopublishalltheroambifilesinthattable.
ThesolutionistousethetFlowToIteratecomponent:
Thefirstsubjobisonchargeofcreatingthesourcefilesyouwanttouse.Inthiscaseitis
creating3excelfiles:TalendSquareSampleArgentina.xlsx,TalendSquareSampleBrazil.xlsx
andTalendSquareSampleUS.xlsx.
Whenthefirstsubjobcompletes,itcallsthesecondsubjobtopublishtherbis.Ituses
tFileInputDelimitedcomponenttoreadthemappingTable.csvfile.
17

Youneedtoedititsschemaparametertomatchthecontentofthecsvfile:
ThenconnectittothetFlowToIteratecomponent.IttakeseachrowfromtheCSV,createsa
globalvariableforeachcolumnandcallsthetRoambiPublishWithFilecomponenttopublishthe
roambifile.
ThisistheconfigurationofthetFlowToIteratecomponent.Addaglobalvariableforeachcolumn
oftheschemareceivedfromthetFileInputDelimitedcomponent.
18
Finally,tRoambiPublishWithFilecomponentisconfiguredusingtheglobalvariablesthatthe
tFlowToIteratecomponentcreatedbeforecallingitforeachrow.
Publishing multiple files using the tFlowToIterate component and Send Email
Notification for Errors.
destinationfolderandpermissions.Ifyouwanttopublishmultipleroambifiles,youmayhave
thismappinginformationinatablestoredinadatabaseorinaCSVfile.
19
Inadditiontothat,thisusecasehasthefollowingadvantages:
Thewholeprocesswillrunforallofthefilesinthemappingtable,nomatterifthereare
errorspublishingsomeofthem.
Theprocesswillsendanemailnotificationpereachfilethatcouldnotbepublished.
AssumingyoualreadycreateyourTalendJobstogeneratetheexcelsourcefiles,andyou
alreadygeneratedthemappingTable.csvfile,thissectionexplainsthejobtopublishthosefiles
toRoambi.
1. Createachildjob(inmyexampleIcallitDemo5_PublishHandleError_SubJob)that
callsthetRoambiPublishWithFiletopublishafileandsendemailnotificationincaseof
error.
Thischildjobwillreceiveitsparametersusingcontextparameters.Createthefollowing
contextparametersoftypeString:SourceFile,Template,DestinationFolder,
RoambiFileName,UsersandGroups.

ConfiguretRoambiPublishWithFilecomponentusingthecontextparameters:
20
MakesureDieonErroroptionisselected.

ConnecttRoambiPublishWithFiletothetSendMailcomponentusingthe
OnComponentErrortriggerlink.

ConfiguretSendMailcomponent.Usethecontextparameterstoconstructtheemail
bodymessage.Example:

"ErrorexecutingtRoambiPublishWithFilecomponentwiththefollowingparameters:\n"+
"SourceFile:"+context.SourceFile+"\n"+
"Template:"+context.Template+"\n"+
"DestinationFolder:"+context.DestinationFolder+"\n"+
"RoambiFileName:"+context.RoambiFileName+"\n"+
"Users:"+context.Users+"\n"+
"Groups:"+context.Groups+"\n"+
"Pleaseseeroambiscriptlogfileformoreinformation.

21
2. Createtheparentjob.ThisisthejobthatpublishesallthefilesinthemappingTable.csv
file.Thisjobcallsthechildjobcreatedinstep1.
ItusestFileInputDelimitedcomponenttoreadthemappingTable.csvfile.
22
ThenconnectittothetFlowToIteratecomponent.IttakeseachrowfromtheCSV,
createsaglobalvariableforeachcolumnandcallsthetRunJobcomponentwhichcalls
thechildjobcreatedinstep1topublishtheroambifile.
ThisistheconfigurationofthetFlowToIteratecomponent.Addaglobalvariableforeach
columnoftheschemareceivedfromthetFileInputDelimitedcomponent.
23
FinallyconfiguretRunJobcomponent.tRunJobcomponentwillcallthechildjobcreated
instep1topublishthefileandsendnotificationincaseoferror.Itpassthevaluesfrom
theglobalvariablescreatedbythetFlowToIteratecomponenttothechildjobcontext
parameters.

MakesureDieonchilderrorisnotset.Thisistoavoidtheprocesstostopwhenan
errorinthechildjoboccurs.

Publishing multiple files using the tFlowToIterate component, Retry in case of

Error and Send Email Notification for Errors.
destinationfolderandpermissions.Ifyouwanttopublishmultipleroambifiles,youmayhave
thismappinginformationinatablestoredinadatabaseorinaCSVfile.
Inadditiontothat,thisusecasehasthefollowingadvantages:
24
Thewholeprocesswillrunforallofthefilesinthemappingtable,nomatterifthereare
errorspublishingsomeofthem.
Theprocesswillretrytopublishthefileincaseoferror.Thenumberofretriesis
configurable.
Theprocesswillsendanemailnotificationpereachfilethatcouldnotbepublishedafter
retrying.
AssumingyoualreadycreateyourTalendJobstogeneratetheexcelsourcefiles,andyou
alreadygeneratedthemappingTable.csvfile,thissectionexplainsthejobtopublishthosefiles
toRoambi.
1. Createachildjob(inmyexampleIcallitDemo6_Publish_SubJob)thatcallsthe
tRoambiPublishWithFiletopublishafileandstoreinaglobalvariablethereturnvalue(0
forsuccessand1forerror).
RoambiFileName,UsersandGroups.Alsonote,weneedanothercontextparameter
calledParentMapoftypeObject.ThisistopasstheglobalMaptowritethereturnvalue
onit.

25
ConfiguretRoambiPublishWithFilecomponentusingthecontextparameters:
MakesureDieonErroroptionisselected.

ConnecttRoambiPublishWithFiletothetJava_1componentusingtheOnComponentOK
triggerlink.

ConfiguretJava_1componenttowritethereturnvalue0(forsuccess)intheglobalMap.

java.util.Mapmap=(java.util.Map)context.ParentMap
map.put("Demo6_Publish_SubJob_RetVal",0)

26
ConnecttRoambiPublishWithFiletothetJava_2componentusingthe
OnComponentErrortriggerlink.

ConfiguretJava_2componenttowritethereturnvalue1(forerror)intheglobalMap.

java.util.Mapmap=(java.util.Map)context.ParentMap
map.put("Demo6_Publish_SubJob_RetVal",1)

2. Createanotherchildjob(inmyexampleIcallit
Demo6_PublishRetryHandleError_SubJob)thatcontainstheretrylogicforasinglefile.
Itloopsthenumberofretriesandexitwhensuccess.Incaseitrunoutofretriesitsend
theemailnotificationforthegivenfile.
27
RoambiFileName,UsersandGroups.Alsonote,weneedanothercontextparameter
calledRetriesoftypeInteger.Thisistopassthenumberofretriesyouwant.

ConfiguretLoopcomponenttoloopasmanytimesgiveninthecontext.Retries
parameter.
Declaration:globalMap.put("Retries",0)
Condition:(Integer)globalMap.get("Retries")<context.Retries
28
Iteration:globalMap.put("Retries",(Integer)globalMap.get("Retries")+1)
ConnecttLoopcomponenttothetRunJobcomponentusingtheiteratelink.

ConfiguretRunJobcomponent.tRunJobcomponentwillcallthechildjobcreatedinstep
1topublishthefile.Itpassthevaluesfromthecontextparametersandalsopassesthe
globalMap.MakesureDieonchilderroroptionisnotset.

ConnecttRunJobcomponenttotSetGlobalVarcomponentusingtheRunIftriggerlink.

TheRunIftriggerlinkisconfiguredwiththecondition:

(Integer)globalMap.get("Demo6_Publish_SubJob_RetVal")==0
29

tocalltSetGlobalVarjustwhenthereturnvaluefromthechildjobis0(success).

ConfiguretSetGlobalVarcomponenttosetglobalvariableRetriestothe
context.Retries,creatingtheconditiontoexitfromtheloopwhenthechildjobcompleted
successfully.

ConnecttLoopcomponenttotSendMailcomponentusingtheRunIftriggerlink.

TheRunIftriggerlinkisconfiguredwiththecondition:

(Integer)globalMap.get("Retries")==context.Retries

tocalltSendMailjustwhenitexittheloopwithmaximumnumberofretries,whichmeans
thepublishfailedinallretries.
30

ConfiguretSendMailcomponent.Usethecontextparameterstoconstructtheemail
bodymessage.Example:

"ErrorexecutingtRoambiPublishWithFilecomponentwiththefollowingparameters:\n"+
"SourceFile:"+context.SourceFile+"\n"+
"Template:"+context.Template+"\n"+
"DestinationFolder:"+context.DestinationFolder+"\n"+
"RoambiFileName:"+context.RoambiFileName+"\n"+
"Users:"+context.Users+"\n"+
"Groups:"+context.Groups+"\n"+
"Pleaseseeroambiscriptlogfileformoreinformation.

31

3. Createtheparentjob.ThisisthejobthatpublishesallthefilesinthemappingTable.csv
file.Thisjobcallsthechildjobcreatedinstep2.
ItusestFileInputDelimitedcomponenttoreadthemappingTable.csvfile.
32
ThenconnectittothetFlowToIteratecomponent.IttakeseachrowfromtheCSV,
createsaglobalvariableforeachcolumnandcallsthetRunJobcomponentwhichcalls
thechildjobcreatedinstep1topublishtheroambifile.
ThisistheconfigurationofthetFlowToIteratecomponent.Addaglobalvariableforeach
columnoftheschemareceivedfromthetFileInputDelimitedcomponent.
FinallyconfiguretRunJobcomponent.tRunJobcomponentwillcallthechildjobcreated
instep2topublishthefile,retryonerror,andsendnotificationincaseoferror.Itpass
thevaluesfromtheglobalvariablescreatedbythetFlowToIteratecomponenttothe
33
childjobcontextparameters.NotethathereyoupassRetriescontextparametertothe
numberofretriesyouwant.

MakesureDieonchilderrorisnotset.
34
Appendix A: Troubleshooting and Common Issues
WheredoIfindRoambiScriptandAPIKey?
RoambScript: Finditin
SAPServiceMarketplace .
RoambiAPIKey: Pleasereferto
HowdoIcreateaRoambiAPIclient?
IamgettingemptydatasetinmyRoambifile
Pleasecheckthefollowingitems
1. Youprovisionedtherightusers,andyouareusingaprovisionedusertotesttheRBI
contents.
2. CheckthatyoursourcereportmatchesthedimensionsusedintheRoambiReport.
3. Theprofilevaluesandfiltersfortheuseractuallymatchesthedatainthesourcereport.
Makesureyoudonothaveadditionalqueryfilterthatrestrictthedatathanintended
4. CheckthatyourRBItemplatecanbeaccessed
Istillhaveissueswiththeextension
Pleasecontact support .Pleasebesuretoprovidethefollowinginformation:
Talendproduct
Briefsummaryofwhatyouaretryingtoaccomplish
RoambiScriptLog(ThiscanbefoundinthefolderwhereyouinstalledRoambiScript)
Componentsandparametersused
Screenshotofreport
35
Appendix B: Version History
Version1.0:May,2015.GeneralReleaseofRoambiEnterpriseTalendComponents
Version2.0:October,2015.Addusecases.
Version2.1:October,2015.Addusersandgroupsparametersinadditiontopermissions
parameterthatwillbedeprecated.
Version2.2:May,2016.UpdatesupportlinkandSAPServiceMarketplacelink.
36

Roam Bi Enterprise Tal End Components

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Roam Bi Enterprise Tal End Components

Caricato da

Copyright:

Formati disponibili

RoambiEnterpriseTalendComponentsMay2016

Creating API Key

1. DownloadRoambiScriptfrom SAPServiceMarketplace .Createafolderthatcanbe

Setting up Roambi Talend Components

III. How to Use

IV. Use Cases

Publishing multiple files using the tFlowToIterate component

Publishing multiple files using the tFlowToIterate component, Retry in case of

Appendix A: Troubleshooting and Common Issues

Appendix B: Version History

Potrebbero piacerti anche