First edition. Copyright Orion Billing A/S All rights reserved

Transkript

1 BRUKERMANUAL First edition. Copyright Orion Billing A/S All rights reserved

2 Forord: Denne brukermanualen vil gi deg en rask innføring i bruken av Orion Billing A/S TapXML-Generator. Manualen er rikt illustrert med bilder og detaljerte forklaringer, men er samtidig enkel å forstå, for at du som leser enkelt skal kunne sette deg inn i programmet. Mannualen vil gå slavisk gjennom et eksempel der vi definerer en tenkt tap fil. Innholdsfortegnelse: Oppstart av programmet: s.3 Definere TAP2+ format: s.4 Definere Productfile format: s.5 Definere CustInfo1 format: s.6 Definere NetworkDevice format: s.7 Generere XML fil: s10 XML Definisjon generert for vårt eksempel: s11

3 Oppstart av programmet: Etter innlogging vil følgende skjermbilde vises: Her vil en kunne velge hvilke format en vil definere xml-kode for. Dersom en har en vanlig tap-fil, vil en da vanligvis gå igjennom alle disse formatene. Current temp files på bunnen er hvilke filer som vil brukes til mellomlagring. Dette er filer som vil være unike og som vil ha blitt opprettet på hardisken til maskinen der programmet kjøres etter hver gang du har logget inn. Etter at du har generert XML Filen, vil disse filene bli slettet og nye, tomme, temp filer vil bli opprettet. Dersom noe skulle gå galt under genereringen av XML filen senere, vil filene ikke bli slettet og en vil da kunne bruke disse filene til feilsøking for å oppdage hva som gikk galt. Vi vil i denne brukermanualen gå slavisk gjennom disse formatene med eksempler og forklaringer på hvordan hvert enkelt felt kan / skal fylles ut. Vi vil starte med TAP2+, gå videre til ProductFile, så Custinfo1 og tilslutt NetworkDevice, før vi generere XML filen.

4 Definere TAP2+ Format: Vi starter med å vise et eksempel på hvordan en kan definere et TAP2+ format. Etter du har trykket på knappen med dette formatet, vil følgende bilde komme opp på skjermen: Det vil her være nødvendig å fylle inn alle feltene. De tre øverse feltene vil være felles for hele TAP2+ XML tagen og trengs bare å fylles inn første gang du definere dette formatet for denne XML filen. De to neste feltene vil være nødvendig for hver record-type, og må fylles inn hver gang. Record-length er lengden på dette recordet. Lengden her er 17 fordi, som det går frem av bildet, at siste record felt slutter på 17. Dersom du sitter verdien på siste record felt høyere en record-length, vil du få en advarsel om dette. Record felt kan du sette inn å fjerne når du ønsker dette ved å trykke på knappene remove field og New record field. Start-feltene vil automatisk starte med en verdi 1 høyere en End feltet i rekken over. Dersom en End er lavere en forrige End, vil du få en advarsel om dette. Etter du har fylt ut alle feltene kan du enten velge å definere en ny record-type, og samme skjermbilde vil komme igjen, eller du kan trykke Done for å definere et annet format.

5 Definere ProductFile Format: Å definere ProductFile er bygget opp på samme måte som for TAP2+, og også CustInfo1. Du vil her bare trenge å fylle inn de tre øverste feltene for første record-type, og ikke når du ønsker å legge til flere record-typer. Også her legger du til og fjerner felt etter behov. Position feltene vil her automtisk bli nummerert fra 1 og oppover etterhvert som du legger til nye felt. Du kan her enten velge format fra rullegardin-vinduet eller skrive inn en verdi manuelt. Dersom du skulle komme til å både velge i rullegardin-vinduet og i tillegg skrive inn manuelt, er det verdien som du skrev inn mannuelt som vil bli lagret i XML-koden, da programmet vil gå utifra at det var den verdien du egentlig mente å taste inn. Du kan også her legge til flere record-typer ved å trykke knappen New record type. Etter du har lagt til ønsket antall record-typer, trykker du på Done for å definere et annet format, eller evnt generere XML-filen.

6 Definere CustInfo1 Format: CustInfo1 er formatet er nesten helt likt til ProductFile formatet. Eneste forskjellen er at man i CustInfo1 formatet også definerer en Start exclude -tag og en And exclude -tag. Som vi ser av bildet over har vi her fylt ut format både mannuelt og ved å velge i rulle-gardin - feltet. Det er da +1GMT-Time som vil bli lagt til i XML-filen. Vi vil ikke gå nærmere igjennom definisjonen av dette formatet siden resten er helt likt som ProductFile. Dersom du likevel skulle lure på noe, kan du bla tilbake til side 5 for å gå igjennom ProductFile igjen.

7 Definere NetworkDevice Format: NetworkDevice formatet er et mer komplekst format enn de tre andre vi til nå har gjennomgått. Det består av en hovedtag NetworkDevice med en ID og et navn. IDen vil bli automatisk skrevet inn for hver NetworkDevice du legger til, og du vil som bruker ikke ha mulighet til å forandre denne. IDen vil automtisk øke med 1 for hver device. Navnet må du selv skrive inn, men dette vil bli automtisk innsatt hvis du velger å legge til flere adaptere. Definisjonen av adapter går over 3 sider, noe som er gjort for å begrense datamengden pr.side for å gjøre det lettere for deg som bruker å holde en oversikt over hva som er skrevet inn Feltene som trengs fylles ut her vil variere fra leverandør til leverandør (Netcom, Telenor, Telia, osv), så de feltene du ikke fyller ut, vil ikke bli lagt til i XML-filen. Dersom definisjonen du har fått fra leverandør ikke inneholder noe beskrivelse for noen av feltene, trenger du ikke fylle inn noe, da disse nok ikke skal være med.

8 Definere NetworkDevice Format: På side to, under definisjonen av NetworkDevice formatet, vil du få opp følgende skjermbilde: Om du her velger å fylle ut Group delen eller Tax-Group delen avhenger av hvilken adapter type du definerer, men du må bare fylle ut en av disse delene. Dette gjelder også om du velger å legge til flere grupper ved å trykke på New tax/-group knappen for å legge til en ny gruppe. Har du først startet på en Tax-Group definisjon, må du holde deg til denne. Dette både for å ungå mulig feil-definisjon i XML-filen, og også fordi programmet senere, under parsing av XML-filen, vil kunne missoppfatte verdien dersom disse to feltene blandes. Etter at du har lagt til det ønskede antall tax/-group felter, kan du trykke Next page, for å gå videre til siste steg for å definere en adapter.

9 Definere NetworkDevice Format: Datafilter-tagen brukes av noen adaptere, men langtifra alle. Dersom denne ikke er med for den adapteren du ønsker å definere, trenger du ikke fylle ut noe her og denne tagen vil bli utelatt under genereringen. Du kan da allerede nå velge å definere en ny adapter for denne Network- Devicen ved å trykke New Adapter -knappen, eller du kan trykke Done om du er ferdig med å definere denne NetworkDevicen og vil gå tilbake til hovedmenyen, for evnt definere en ny NetworkDevice eller, om ønskelig, generere XML-filen. Dersom adapteren du er i ferd med å definere krever datafilter, må du fylle ut feltene på denne siden. Du må da fylle ut med den informasjonen du har fått oppgitt og med de riktige stiene. Du kan også her legge til og fjerne condition-felt ved å trykke på Insert condition field - og remove condition field - knappene. Etter du har fylt ut alle felter med nødvendig informasjon, kan du trykke New adapter for å definere en ny adapter, eller Done for å komme til hovedmenyen.

10 Generere XML-fil: Når du er ferdig med å definere de formatene du ønsker, kan du trykke på Generate XML File -knappen. Du vil da få opp en melding under denne knappen. Dersom meldingen lyder at xml-filen ble velykket generert, er temp-filene blitt slettet, og nye tomme temp-filer er opprettet slik at du kan starte på nytt med en ny definisjon dersom det er ønskelig. Dersom filen ble velykket opprettet og du ønsker å se XML-filen, kan du trykke på meldingen og filen vil åpne seg i et nytt vindu. Etter du har lukket dette vinduet, kan du forsestte å definere nye XML-filer dersom det er ønskelig, eller du kan logge ut / lukke vinduet dersom du er ferdig.

11 XML-Definisjon generert for vårt eksempel: Dersom du velger å se filen, vil du få opp følgende i vinduet som åpner seg (dersom du har valgt samme input som i vårt eksempel): <?xml version= 1.0?> <!-- This file is automaticly generated by Orion Billing TapGen 22:46: > <NetworkModel> <Dictionary> <FileFormat name= TAP2+ > <RecordTypeLen>2</RecordTypeLen> <SymSectionRecord>10</SymSectionRecord> <Record RecordType= 10 RecordLen= 17 > <Field StartPosition= 1 EndPosition= 2 Format= 9 >RT</Field> <Field StartPosition= 3 EndPosition= 7 Format= X >SN</Field> <Field StartPosition= 8 EndPosition= 12 Format= X >RN</Field> <Field StartPosition= 13 EndPosition= 17 Format= YYMMDD >FCD</Field> </Record> </FileFormat> <FileFormat name= ProductFile > <extension>.dat</extension> <delimiters>;</delimiters> <Record RecordType= H > <Field Position= 1 >id</field> <Field Position= 2 >firm</field> <Field Position= 3 >data</field> <Field Position= 4 >1</Field> </Record> </FileFormat> <FileFormat name= CustInfo1 > <extension>.d16</extension> <delimiters>;</delimiters> <startexclude>(</startexclude> <andexclude>)</andexclude> <Record RecordType= H > <Field Position= 1 >name</field> <Field Position= 2 >organizationid</field> <Field Position= 3 >coadress</field> <Field Position= 4 >+1GMT-Time</Field> </Record> </FileFormat> </Dictionary> <NetworkDevice id= 1 name= Netcom > <Mediation> <Adapter name= TapFileAdapter > <Retriever settingsname= com.orionbilling.server.mediation.util.retriever.ftpretrieversettings classname= com.orionbilling.server.mediation.util.retri ever.ftpretriever > <Connection> <hostname>ftp.orionbilling.com</hostname> <username>username</username> <password>password</password> <filepath>chess/tapfiles</filepath> <filefinalpath>data/mediation/tapfiledir</filefinalpath> <direction>fromvnd</direction> </Connection> </Retriever> <Parser settingsname= com.orionbilling.server.mediation.util.parser.tapfileparsersettings classname= com.orionbilling.server.mediation.util.parser.tap FileParser > <File Path= /data/mediation/tapfiledir/netcom FinalPath= /data/mediation/tapfiledirout > <FileFormat name= TAP2+ > <Record RecordType= 20 RecordLen= 180 > <Field StartPosition= 159 EndPosition= 160 Format= X Useable= no >OID</Field> </Record> </FileFormat> </File> </Parser> <TargetDataShaper settingsname= com.orionbilling.server.mediation.util.targetdatashaper.cdrtransformersettings classname= com.orionbilling.serve r.mediation.util.targetdatashaper.netcomtransformer > <RecordsLimit>50000</RecordsLimit> <delimiter>;</delimiter> <recipient>netcom</recipient> <Group> <Filter settingsname= com.orionbilling.server.mediation.util.filter.cdrfiltersettings classname= com.orionbilling.server.me diation.util.filter.cdrfilter > <Criterion> <Condition Type= s Operation= = Value1= 20 >RT</Condition> <Condition Type= s Operation=!= Value1= >CR</Condition> </Criterion> </Filter> </Group> <DataFilter settingsname= com.orionbilling.server.mediation.util.filter.cdrfiltersettings classname= com.orionbilling.server.mediation.u til.filter.cdrfilter > <Criterion> <Condition Type= s Operation= = Value1= 40 >RT</Condition> <Condition Type= s Operation= = Value1= >CR</Condition> </Criterion> </DataFilter> </TargetDataShaper> </Adapter> </Mediation> </NetworkDevice> </NetworkModel>

12