DaTelTek ApS ich 4 SpAPI Telenor Serviceprovider API

Transkript

1 DaTelTek ApS ich 4 SpAPI Telenor Serviceprovider API Release DaTelTek ApS Birkevej 4 DK-4640 Faxe Denmark CVR: info@dateltek.dk

2 Indholdsfortegnelse Ændring og opdaterings historik... 4 ich 4 SpAPI beskrivelse... 5 Definitioner... 6 Funktioner... 7 Hovedmenuen... 7 Status... 8 Portering... 9 Stop portering Aktiver egne numre Aktiver SIM Aktiver Multi SIM Aktiver via CSV fil Aktiver reserverede Fjern reservation Afbryd indportering Vedligehold numre Luk nummer Åben nummer Slet SOC Tilføj SOC Skift profil Sunc profil Skift SIM kort Skift Nummer Genindlæs Historik Vedligehold SOCs Vedligehold profiler Appendix A Page 2 of 23

3 CSV filformat Page 3 of 23

4 Ændring og opdaterings historik API-Version Date Changes / First release. Page 4 of 23

5 ich 4 SpAPI beskrivelse ich 4 SpAPI (herefter SpAPI) er en udvidelse til Datelteks ich 4 system. Det kan dog anvender uden ich 4 faciliteterne med enkelte begrænsninger. SpAPI stille nogle enkle og simple menuer til rådighed for brugeren, der gør denne I stand til at starte og stoppe porteringer, vedligeholde egne numre, vedligeholde mulige SOCs og placer disse I profiler. SpAPI kan ikke ses som en fuldstændig erstatning for bruge af Telenors New Delfi system, men alle normale daglige opgaver vil kunne løses gennem SpAPI. Der er brugerdifferentieret adgang til SpAPI, men for at afdække alle funktioner i systemet, tager hele denne dokumentation udgangspunkt i, at brugeren har adgang til alle dele af SpAPI et. SpAPI stille ikke faciliteter for kundevedligehold til rådighed. Kunderelationer forventes vedligeholdt andetsteds. Egne numre er all de numre som man er Serviceoperatør for. Når man starter en Indportering vil nummeret for denne Indportering først blive et eget nummer på det tidspunkt hvor servicen for nummeret, via OCH, bliver overdraget til os. Page 5 of 23

6 Definitioner I det følgende er der brugt nogle termer som der kort redegøres for her. SOC / SOCs - Beskriver de servicefaciliteter der tilknyttes til et givent nummer. Eksempler herpå kan være ANR04 der beskriver A-nummer repræsentation = Vis nummer. Det er forskelligt fra operatør til operatør hvilke SOCs de har mulighed for. Profil beskriver en samling af SOCs som man på en let måde kan identificere. Et eksempel kunne være en profil Erhverv der kunne have et antal SOCs tilknyttet og Privat der så har nogle andre SOCs. Ligeledes er der en prisplan knyttet til enhver profil. Indportering er den proces der startes når man ønsker at indportere et nummer fra en anden operatør. Her er det vigtigt at vide, at det kun er Netværksoperatøren der kan starte en portering (sende en NP_Create). Som serviceoperatør skal man forespørge sin netværksoperatør om dette på ens vegne. Det er denne forespørgsel som er en af de muligheder dette SpAPI stiller til rådighed. NP_Create er den funktion som netværksoperatøren sender til OCH for at påbegynde en portering, typisk på vegne af en serviceoperatør. NP_Cancel er den funktion som netværksoperatøren sender til OCH for at afbryde (Cancel) en allerede opstartet portering. Dette kan KUN gøres indtil der nummeret er flyttet (PONS = Point Of No Stop). Donor er den afgivne operatør ved en portering Written Termination er den fuldmagt man som serviceoperatør skal afsende til donor hvis ikke man har aftale om SIM-validering CSV filer er simikolon separerede file. Typisk genereret af fx Microsoft Excel. Beskrivelse af formatet for disse, findes i appendix. Page 6 of 23

7 Funktioner Hovedmenuen Hovedmenuen SpAPI har følgende underpunkter. Status følge status på alle numre. Egne numre såvel som igangværende porteringer. Portering starte en indportering (CreateSubscriber med portering). Stop portering stop en igangsat portering (NP_Cancel) Aktiver egne numre oprette relation mellem SIM-kort og telefonnumre. Reservere og/eller aktivere disse. De-aktivere, herunder og afbryde en igangsat indportering. Vedligehold numre Lukke/Åbne numre. Tilføje eller fjerne SOCs på numre samt anden vedligehold. Vedligehold SOCs oprette og vedligehold SOCs allerede defineret i New Delfi. Vedligehold profiler kombinere SOCs i forskellige grupper med nemmere aktivering. Batch processing udfører handling på en liste af numre importeret via.csv fil. Et eksempel kunne være at tilføje eller fjerne en SOC på listen af numre. Page 7 of 23

8 Status Under Status kan man se alle de numre som systemet kender samt den øjeblikkelige status på disse. I Displaytype kan søgningen af numre begrænses til Reserverede, Aktiverede, Lukkede samt Canceled. Hvis ikke andet er valgt, vises alle numre. I feltet Søg kan indtastes et nummer, eller dele heraf, hvorefter systemet kun vil vise de numre der passer. I kolonnen GSM nummer vises det aktuelle GSM nummer, i Status vises de øjeblikkelige status, f.eks. bliver der her vist en dato hvis et nummer under indportering er blevet bekræftet af donor, en afvisningsgrund hvis porteringen er afvist eller om et eget nummer er aktivt, lukket osv. I kolonnen Opret dato vises hvornår nummeret er oprettet første gang i systemet. I kolonnen Ændret står en dato for sidste ændring af nummeret. I kolonne SIM nummer vises det tilknyttede SIM-kort der blev angivet ved oprettelsen. Det er muligt at trykke direkte på nummeret, hvorved man føres direkte til Vedligehold af nummer Page 8 of 23

9 Portering Under menuen Portering er det muligt at opstarte en indportering. Der indtastes et telefonnummer, et tildelt SIM-kort (det nye SIM-kort det udleveres til kunden) og eventuelt donor oprindelige SIM-kort nummer. Hvis man har aftale med donor om SIM-validation er det tilstrækkeligt blot at udfylde dette felt, i modsat fald skal der fremsendes en underskreven fuldmagt til donor. Slutteligt kan man indtaste den dato hvor man ønsker nummeret porteret eller alternativt markere INGEN DATO. Hvis man benytter INGEN DATO er det op til donor at bestemme hvornår nummeret afgives, typisk efter en bindingsaftale. Herefter trykkes på Start og en portering påbegyndes via Telenor og status kan følge under Status som tidligere beskrevet. Page 9 of 23

10 Stop portering Under menuen Stop portering er det muligt at stoppe en portering der er igangsat men endnu ikke gennemført. Der indtastes et telefonnummer og trykkes på Start og porteringen vil da blive stoppet. (Der afsendes en NP_Cancel) Bemærk: Man kan kun nå at stoppe en igangsat portering indtil Telenor har afsendt en NP_Completion. Dette gøre på det af donor - bekræftede porterings tidspunkt. Page 10 of 23

11 Aktiver egne numre Disse funktioner er delt op i 5 grupper. Aktiver SIM der sammenknytter et SIM-kort og et GSM-nummer, reserverer og eventuelt aktiverer dette. Aktiver Multi SIM der sammenknytter en gruppe af SIM-kort med en tilsvarende gruppe af GSMnumre. Ved Aktiver Multi SIM vil nummeret aktiveres samtidig med reservationen. Aktiver via CSV Der laver samme funktion som Aktiver Multi SIM, alle data importeres blot fra CSV fil i stedet for indtastning direkte i skærmens formular, og det er muligt at benytte forskellige profiler på hver enkelt nummer. Aktiver reserverede giver mulighed for at aktivere et nummer som tidligere er reserveret men endnu ikke aktiveret. Fjern reserveret kan fjerne et reserveret nummer der endnu ikke er aktivt. Der er også her man kan afbryde en indportering (sender en NP_Cancel) Aktiver SIM Denne funktion giver mulighed for at reservere og eventuelt samtidig aktivere et GSM-nummer / SIM-kort. Indtast et GSM-nummer, et SIM-kort og tryk Start. Reservation og aktivering sættes nu i gang. Hvis der ikke er markeret i feltet Aktiver nu bliver nummeret kun reserveret og ikke aktiveret. Hvis det kun er reserveret er det muligt at ophæve denne reservation igen. Page 11 of 23

12 Aktiver Multi SIM Denne funktion giver mulighed for at reservere og aktivere en pulje af numre. Alle GSM-numrene indtastes i boksen og tilsvarende indtastes alle SIM-kort i den her til hørende box. Når alle nummerpar er indtastet, trykkes på Valider. Valider laver en kontrol at hver enkelt nummer, dels at ikke nummeret allerede er fundet i systemet dels at SIM-kortet ikke allerede er tildelt et nummer. Ligeledes kontrolleres at der er lige mange GSM-numre som der er SIM-kort. Resultatet af denne validering vises på en list, de som forventes at gå igennem vises i grønt, og de som har fejl og IKKE bliver sendt til Telenor vises med rødt. Se liste nedenfor. Page 12 of 23

13 Hvis man er tilfreds med valideringen, vælges så en profil (= samling af SOCs der tillægges nummeret) og der trykkes på Start. Aktiveringen går herefter igen. BEMÆRK: Hvis der indtastes mere end 25 GSM/SIM par, udføres aktiveringen IKKE øjeblikkeligt, men lægges i kø og afvikles efter reglerne bestemt af Telenor. Page 13 of 23

14 Aktiver via CSV fil Der vælges en.csv-fil i Vælg.CSV fil og trykkes på Start. Filformatet på.csv filen findes i Appendix. Alle aktiveringer lægges i kø, og afvikles efter regler tildelt af Telenor (i passende timeslots ) Page 14 of 23

15 Aktiver reserverede Såfremt et nummer kun har været reserveret og IKKE aktiveret, kan dette aktiveres med denne funktion. Nummeret indtastes i feltet eller vælges over listen med kendte ikke aktiverede numre. Herefter vælges den profil man ønsker at aktiveret nummeret med, og der trykkes på Start. Nummeret aktiveres nu og skifter samtidig status fra Reserveret til Aktiv Page 15 of 23

16 Fjern reservation Afbryd indportering Denne funktion benyttes til at fjerne reserverede eller aktiverede numre. Hvis det kun er reserverede numre sker dette øjeblikkeligt, hvorimod Telenor har en Retensiontime inden et aktiveret nummer frigives til ny brug. Nummeret hvorpå reservationen (aktiveringen) ønskes fjernet og der trykkes på Start. Er der tale om et nummer hvorpå der er startet en indportering, men denne IKKE er tilendebragt, sendes en NP_Cancel og porteringen afbrydes. Denne funktion findes også som overordnet menu, Stop portering Page 16 of 23

17 Vedligehold numre Under vedligehold findes de fleste funktioner. Man indtaster et nummer i feltet GSM nummer eller man kommer til menuen via Statuslisten. Hvis nummeret IKKE eksisterer i det interne system, gives der mulighed for at Genindlæse dette. Se herom senere. Følgende funktioner er mulige: Luk nummer denne funktion lukker et nummer, f.eks. ved restanceproblemer. Åben nummer Kan åbne et i forvejen lukket nummer. Slet SOC Man kan slette en bestem SOC tilknyttet et nummer. Tilføj SOC Man kan vælge en SOC i listen og tilføje denne. Page 17 of 23

18 Skift profil eller synkroniser til profil. Skift SIM kort på et nummer Skift nummer på et SIM kort Genindlæs Man kan Genindlæse data fra Telenor. Historik viser historikken på en nummer. Luk nummer Hvis man ønsker at lukke et nummer (spærre for brug) trykkes Luk nummer. Der kan specificeres en dato for nummerlukningen, men hvis intet ændres, lukkes nummeret øjeblikkeligt. Denne funktion er naturligvis kun mulig hvis nummeret ikke allerede er lukket, i modsat fald vil Åben nummer være tilgængelig i stedet. Åben nummer Hvis et nummer har været lukket, og det ønskes gen-åbnet trykkes på Åben nummer. Denne er naturligvis kun aktuelt og muligt hvis nummeret tidligere er blevet lukket. Slet SOC På oversigten vises en liste over de SOCs der netop nu, måtte være tilknyttet nummeret. Hvis en eller flere af disse SOCs ønskes slettet, trykkes på Slet SOC. Den pågældende SOC slettes øjeblikkeligt. Tilføj SOC I boksen Tilføj SOC til nummer findes en liste over alle tilgængelige SOCs. For at tilføje en SOC til et nummer, vælges den pågældende SOC i listen og der trykkes på Tilføj SOC Skift profil Skifter profil på nummeret til den valgte Sunc profil Såfremt der er forskel på de SOCs i profilen og de SOCs som det aktuelle nummer har tildelt, vil knappen Sync profil fremkommer. Ved at aktivere denne funktion, vil nummeret forsøges synkroniseret med profilen. Det vil sige, at de SOCs der findes på nummeret men ikke i profile vil blive slette på nummeret, og ligeledes de SOCs der findes i profile, men ikke på nummeret vil blive tilføjet. Skift SIM kort I boksen Skift SIM kort til indtastes det nye SIM kort der ønskes tilknyttet nummeret. I listen vælges en ReasonText og der trykkes Skift SIM Page 18 of 23

19 Skift Nummer I boksen Skift GSM nummer til indtastes det nye GSM nummer der ønskes tilknyttet til det aktuelle SIM kort. Her efter trykkes Skift GSM Genindlæs Genindlæs henter alle relevante data fra Telenor og opdaterer den interne database på nummeret. Det kan være aktuelt hvis der har været lavet ændringer på nummeret andetsteds fra, f.eks. via New Delfi eller hvis nummeret er oprettet før systemet tages i brug. Historik Under historik kan ses alle de ændringer der måtte være sket med et nummer siden det første gang blev reserveret / aktiveret. Hvilke SOCs er lagt på nummeret, hvilke er fjernet osv. Page 19 of 23

20 Vedligehold SOCs Oversigten over SOCs vises. Kolonnen SOC viser navnet på den pågældende SOC. Dette er defineret af Telenor i samarbejde med den enkelte operatør. Kolonne SOC navn viser en forklaring på den enkelte SOC. FeatureCode og Custom parameter er felter som kun yderst sjældent skal benyttes og altid i samarbejde med Telenor / system leverandøren. Kolonnen Beskrivelse er til egne notater. Den sidste kolonne viser antallet af profiler hvori denne SOC er benyttet. Det er ikke muligt at slette en SOC der er i en aktiv profil. Man kan redigere i en SOC ved at klikke på navnet eller man kan oprette en ny SOC ved at klikke på Indsæt ny SOC. Om der er en ny SOC der oprettes eller en eksisterende SOC der redigeres, fremkommer nedenstående: Heri kan de enkelte elementer indtastes / redigeres. Såfremt at en SOC der redigeres ikke er i brug i nogle profiler, vil en knap Slet forekomme. Denne benyttes til at fjerne denne SOC fra systemet. Page 20 of 23

21 Vedligehold profiler Oversigten over profiler vises. Kolonne Profil navn viser det navn man har givet profilen, Beskrivelse beskriver med korte ord profilen. Der vises også kolonnen SOCs i profil. Denne fortæller hvilke SOC der er tilknyttet denne profil. Det er muligt at vælge en eller flere SOC i boksene for at flytte SOC til og fra den enkelte profil. Ved at klikke på profile navnet eller trykke Indsæt ny Profil kommer følgende: Heri kan profilens navn og beskrivelse oprettes / ændres eller profilen kan helt slettes. Page 21 of 23

22 Batch processing Page 22 of 23

23 Appendix A CSV filformat Filformatet for.csv filer i systemer skal have følgende format: Blanke linier ignoreres af systemet. 1 linie i filen kan, man skal ikke, indeholde navne på felterne der er i filen. Hvis intet er angiver antager systemet at felterne kommer i følgende rækkefølge: GSM;SIM;PROFILE Et eksempel på indhold til aktivering af numre/sim kort kunne se således ud: GSM;SIM;PROFILE ; ;Erhverv ; ;Privat ; ; ; ;Privat ; ;Privat ; ; ; ;Privat I dette tilfælde er det kun nogle af numrene der har beskrevet en profil, de øvrig numre aktiveres med den default profil der blev valgt ved indlæsningen af.csv filen. Et eksempel på en.csv fil til Batch processing kunne se således ud: GSM;ADDSOC ;ANR ;ANR ;ANR04 I batchprocessing kan anvendes følgende actions: ADDSOC DELSOC - tilføjer den givne SOC til nummeret - Fjerne den givne SOC fra nummeret Page 23 of 23