Dokumentacja_HiperusLib_1_1_zaleznosci

Spis treści
Wstęp...............................................................................................1
Diagram asocjacji...............................................................................2
Opisy klas..........................................................................................3
Opisy asocjacji...................................................................................4
Proces uruchamiania klienta.................................................................5
Wstęp
Niniejszy dokument opisuje zależności pomiędzy bytami platformy Hiperus.
1/7
Diagram asocjacji
2/7
Opisy klas
Customer – klasa reprezentująca klienta końcowego w platformie Hiperus, obiekty
tej klasy przechowują nazwę, dane teleadresowe, dane potrzebne do wystawiania
faktur, ustawienia danego klienta. Do tworzenia rekordu klienta służy akcja
AddCustomer
Terminal – klasa reprezentująca urządzenie podłączane do platformy Hiperus
(bramka VoIP, telefon IP, softphone, gateway...). Obiekty tej klasy przechowują takie
dane jak nazwa użytkownika I hasło używane do autoryzacji połączeń wychodzących
oraz rejestracji w platformie Hiperus dla połączeń przychodzących. Na podstawie
informacji zawartych w obiektach tej klasy determinowany jest koszt połączenia,
ewentualny limit czasu, abonament I sposób jego naliczania, lokalizacja terminala dla
połączeń alarmowych, uruchomienie protokołu T.38 jeżeli zostanie wykryty fax CNG,
“screening” numerów A przychodzących z terminala.
PSTNNumber – klasa reprezentująca miejski numer telefonu z jakiego może
korzystać użytkownik. Przechowuje ona dane między innymi o numerze telefonu,
wirtualnym faksie, numerze głównym, kodzie kraju.
EndUserAuth – klasa reprezentująca użytkownika panelu końcowego klienta, za
pomocą którego klienci mogą sprawdzać swoje billingi, doładowywać konta,
przeglądać faksy, odsłuchiwać wiadomości. Dane tutaj zawarte to między innymi email
(który jest loginem używanym do zalogowania sie do panelu) oraz hasło. Na
podawany tutaj email platforma Hiperus wysyła wirtualne faksy oraz wiadmości
głosowe pozostawione w skrzynce głosowej.
CustomerPricelist – klasa reprezentująca cennik dla klienta końcowego (cennik
przychodowy). Zawiera nazwę cennika wykorzystywaną do przypisywania danego
zestawu cen do terminala, oraz flagę informującą podsystem billingowy czy naliczać
połączenia wewnątrz platformy.
VPBXExtension – klasa reprezentująca wirtualny numer wewnętrzny. Zawiera
między innymi numer wewnętrzny, informacje o terminalu jaki ma obsługiwać numer
3/7
wewnęŧrzny, nazwę jaka ma być wyświetlana na urządzeniach dzwoniących wewnątrz
wirtualnej centralki.
VPBX – klasa reprezentująca wirtualną centralkę zdefiniowaną dla klienta
końcowego. Zawiera między innymi dane dotyczące cyfry wyjścia, długości numerów
wewnętrznych w centralce, numeru głównego z puli miejskiej.
Subscription – klasa reprezentująca abonament przypisany do terminala. Określa
date rozpoczęcia trwania abonamentu, date zakończenia, wartość jaka pozostała do
wykorzystania w danym miesiącu. Determinuje także konfiguracje abonamentu tzn.
wartość za minute na poszczególne kierunki.
Opisy asocjacji
customer_terminal – asocjacja jeden-wiele. Jeden klient może mieć wiele
urządzeń (terminali). Możliwe jest, że klient nie posiada żadnego zdefioniowanego
terminalu.
terminal_pstnnumber – asocjacja jeden-wiele. Jeden terminal może obsługiwać
wiele numerów telefonów. Możliwe jest, że terminal nie ma przypisanego żadnego
numeru telefonu, wówczas służy tylko do wykonywania połączeń wychodzących, w
sygnalizacj międzyoperatorskiej przydzielany jest numer główny wiązki dla platformy
Hiperus oraz ustawiane jest zastrzeżenie prezentacji. Jeżeli terminal ma zaznaczoną
flage screening terminal może przysłać tylko numery które są do niego przypisane,
jeżeli wyśle numer nie znajdujący się na liście zostanie on zamieniony na numer
główny przypisany do niego.
enduserauth_terminal – asocjacja jeden-wiele. Jeden użytkownik końcowy może
być przypisany do wielu terminali, w obrębie klienta dla którego został zdefiniowany.
Połączenia wykonywane za pomocą terminala, faksy przychodzące, wiadomości w
poczcie głosowej będa wyświetlane w panelu końcowego klienta przypisanemu
użytkownikowi.
enduserauth_pstnnumber – asocjacja jeden-wiele. Jeden użytkownik końcowy
może być przypisany do wielu numerów telefonów, w obrębie klienta dla którego
4/7
został zdefiniowany. Połączenia związane z numerem telefonu, faksy przychodzące,
wiadomości w poczcie głosowej będa wyświetlane w panelu końcowego klienta
przypisanemu użytkownikowi.
terminal_pricelist – asocjacja jeden-wiele. Jeden cennik może być przypisany do
wielu terminali. Podsystem billingowy wykorzystuje to przypisanie w celu naliczenia
kosztu połączenia dla klienta.
terminal_vpbxexten – asocjacja jeden-wiele. Jeden terminal może obsługiwać
wiele numerów wewnętrznych.
vpbx_vpbxexten – asocjajca jeden-wiele. Jedna wirtualna centralka (VPBX)
zawiera wiele numerów wewnętrznych.
Proces uruchamiania klienta
Opis ten zawiera informacje dotyczącą procesu uruchamiania klienta w kontekście
akcji jakie należy wykonać na rzecz PLATFORM_MNGM.
Wymagania wstępne
Przed przystąpieniem do uruchamiania klienta w platformie Hiperus musi być
zdefiniowany przynajmniej jeden cennik dla klienta końcowego, aby tego dokonać
należy wykonać w podanej kolejności następujące akcje:
– AddCustomerPricelist
– SaveSimpleCustomerPricelist
lub
– ImportCustomerPricelist (do importu można wykorzystać dane zwrócone za
pomocą metody GetCustomerPricelistEntryListAll)
Jeżeli klient ma mieć zdefiniowany abonament, przed rozpoczęciem dodawania
należy takowy stworzyć, do wykorzystywania później. W tym celu należy wywołać
następujące akcje:
5/7
– AddSubscription
– AddSubscriptionConfig
Jeżeli tworzony klient ma mieć przypisany miejski numer telefonu wcześniej
powinna być zdefiniowana pula numeracyjna, można to sprawdzić za pomocą akcji:
– GetPlatformNumberingRange (zwraca przydzielone zakresy)
– GetPlatformNumberingUsage (zwraca szczegółowo numery przydzielone dla
zadanego zakresu z informacja o ewentualnym przypisaniu)
Uruchomienie / przypisanie numeracji jest dokonywane przez obsługę platformy
Hiperus podczas uruchamiania konta dystrybutorskiego.
Uruchamianie klienta, lista akcji w kolejności wywołań:
– AddCustomer (dodanie rekordu klienta)
– AddEndUserAuth (jeżeli ma mieć dostęp do panelu końcowego klienta)
– AddExtension. Do podania parametru “numer” można skorzystać z akcji
GetFirstFreePlatformNumber, zwracającej pierwszy wolny numer albo z akcji
GetPlatformNumberingRange, a pozniej GetPlatformNumberingUsage w celu
wyboru numeru z listy. W celu automatycznego utworzenia terminala należy ustawić
parametr create_terminal = true, system wygeneruje nazwe terminala taka jak
numer telefonu oraz hasło. Jeżeli potrzeba można podać identyfikator końcowego
klienta (po dodaniu go za pomocą AddEndUserAuth), identyfikator abonamentu
wraz z parametrami rozpoczęcia i zakończenia jego trwania, identyfikator lokalizacji
dla służb alarmowych.
– Jeżeli klient ma nie mieć przypisanych numerów miejskich zamiast akcji
AddExtension należy wywołać akcje AddTerminal
Definiowanie wirtualnej centrali
6/7
Jeżeli uruchamiany klient ma mieć uruchomioną wirtualną centralę, po wywołaniu
akcji AddCustomer i wykonaniu kroków z punktu “Uruchamianie klienta” należy:
– Wywołać tyle razy akcje AddTerminal (lub AddExtension, jeżeli terminal ma
obsługiwać jednocześnie numer miejski) ile urządzeń ma się znaleźć w wirtualnej
centrali
– Wywołać akcje AddVPBX
– Wywołać tyle razy akcje AddVExtension ile numerów wewnętrznych ma zostać
utworzonych
7/7