Halaman /19
Equnix Business Solutions, PT
Definisi Stargate
Merupakan sebuah sistem yang berperan sebagai router/switch untuk menghubungkan aplikasi lain agar dapat mengirimkan dan menerima SMS dengan mulus. Modem GSM/CDMA dihubungkan pada bagian lain dari switch. Sistem ini mengelola dan menjaga SMS traffic, penggunaan air-time, kekuatan sinyal, filtrasi token, dan routing berdasarkan prefix dengan sistem monitoring dan kontrol yang komprehensif. Protokol yang didukung untuk berkomunikasi dengan aplikasi SOAP-XML, XML-RPC, HTTP GET dan banyak lagi.
User Interface Login
Masukkan Username dan Password kemudian klik tombol login untuk masuk ke halaman utamanya.
Halaman 1/19
Equnix Business Solutions, PT
Halaman Utama
Panel Atas : Isian
Deskripsi
Change Password
Untuk mengganti Password
User Management
Untuk memanage user
Report
Untuk mengenerate laporan dan grafik
View Log
Untuk melihat log aplikasi
Configure Application
Melakukan konfigurasi/setting parameter
Log Out
Keluar dari aplikasi
Halaman 2/19
Equnix Business Solutions, PT
Menu Add Group: Digunakan untuk menambahkan group. Dalam menu ini terdapat 2 macam group yaitu Inbound dan Outbound, group dapat dibuat sesuai dengan kebutuhan.
Halaman 3/19
Equnix Business Solutions, PT
Inbound Group
Inbound Group diidentifikasi dengan warna merah muda untuk membedakannya dengan Outbound Group yang berwarna hijau muda. Gambar ini menunjukkan Inbound Group yang sedang aktif. Untuk keterangan gambar no [1] dan [2] yang ada di menu Inbound dan Outbound dijelaskan seperti berikut : •
[1] adalah menu Select Modem to be added to the Group Untuk Modem ID
: diisikan nama untuk modem.
Untuk Device
: diisikan alamat lokasi modem tersebut dalam format IP Port.
Halaman 4/19
Equnix Business Solutions, PT
•
[2] adalah contoh tampilan modem yang telah di tambahkan dari menu add di nomor [1].
Dalam Inbound Group terdapat Isian
Deskripsi
Method
Pilih method berdasarkan kebutuhan, terdapat 4 method disini, yaitu : • HTTP GET Sync • HTTP GET Async • SOAP XML Sync • SOAP XML Async
URI
Digunakan sebagai penanda lokasi untuk melakukan koneksi ke aplikasi (backend application)
Query String
Untuk mengkonstruksi request ke aplikasi backend
Response Regex
Untuk melakukan parsing respon dari aplikasi backend
Username
Buat username yang nantinya akan digunakan apabila push SMS yang menggunakan Inbound tersebut
Halaman 5/19
Equnix Business Solutions, PT
Password
Memasukkan password yang sesuai dengan username yang telah dibuat
Token Match
Digunakan untuk mencocokkan SMS dengan token yang didaftarkan
Outbound Group
Panel Kiri Isian
Deskripsi
Prefix Allowed
Awalan dari nomor handphone tujuan SMS yang dapat dikirimkan dari Group ini. Isian ini mendukung format Regular
Halaman 6/19
Equnix Business Solutions, PT
Expression (regex) Allowed Application
Daftar dari Inbound Group penerima yang diperbolehkan untuk memberikan SMS reply
Stargate Application Settings
Panel Kiri Isian
Deskripsi
Listen Port
Nilai dalam bentuk karakter numeric, untuk menentukan PORT yang digunakan untuk mengakses Web User Interface (WUI) Stargate. Aplikasi Stargate harus di-restart agar perubahan ini dapat diterapkan
Halaman 7/19
Equnix Business Solutions, PT
Timeout PIN Reply
Nilai dalam satuan detik untuk menunggu balasan PIN
Min Time For Resending
Nilai dalam satuan jam, sebagai waktu untuk menentukan sebuah SMS Masuk dengan pesan dan pengirim yang sama, akan dikirimkan ke aplikasi backend apabila jarak 2 SMS tersebut melebihi konfigurasi ini
Periode of
•
Web Refresh:
Nilai dalam satuan detik, sebagai waktu interval WUI untuk mengambil informasi dan ditampilkan ke layar, sesuai dengan jenis informasi tersebut, misalnya menampilkan perubahan kekuatan sinyal Modem dari waktu ke waktu •
Log Update:
Nilai dalam satuan detik, sebagai waktu interval untuk mengambil log dan ditampilkan ke layar. Konfigurasi hanya digunakan pada layar "Log Monitor" Timeout Application Reply
Nilai dalam satuan detik, sebagai batas waktu tunggu ketika Stargate menghubungi aplikasi backend pada saat ada SMS Masuk
Timeout Application Message
Isi dengan teks pesan yang akan dikirimkan sebagai balasan untuk SMS yang masuk, namun Stargate telah menunggu hingga waktu pada konfigurasi "Timeout Application Message", namun belum mendapat balasan dari aplikasi backend
SMS Lost Reply
Isi dengan teks pesan yang akan dikirimkan sebagai balasan untuk SMS yang masuk Outbound Group namun modem tersebut tidak termasuk dalam Inbound Group manapun
Email Alert
Isi dengan alamat email tujuan pengiriman alert. Masing-masing email dapat diisi per baris
Halaman 8/19
Equnix Business Solutions, PT
SMS Alert
Isi dengan nomor handphone tujuan pengiriman alert. Masing-masing nomor handphone dapat diisi per baris
Panel Kanan (Modem Related Property) Isian
Deskripsi
Signal Level
Nilai dalam satuan dB, untuk menentukan icon (level) yang akan ditampilkan untuk setiap Modem, sesuai dengan kekuatan sinyal dari Modem tersebut
Last Act
Nilai dalam satuan detik, untuk menentukan icon (warna) yang akan ditampilkan untuk setiap Modem, sesuai dengan waktu dari aktivitas terakhir Modem tersebut
Credit
Nilai dalam satuan Rupiah, untuk menentukan icon (warna) yang akan ditampilkan untuk setiap modem, sesuai dengan sisa kredit (pulsa) dari Modem tersebut
Expr
Nilai dalam satuan hari, untuk menentukan icon (warna) yang akan ditampilkan untuk setiap Modem, sesuai dengan sisa Hari sebelum tanggal expiration (masa tenggang) SIM Card Modem tersebut
Check Signal Periode Nilai dalam satuan menit, untuk menentukan masa bagi Stargate untuk melakukan pengecekan sinyal Modem Check Credit Periode Nilai dalam satuan menit, untuk menentukan masa bagi Stargate untuk melakukan pengecekan kredit (pulsa) Modem
Halaman 9/19
Equnix Business Solutions, PT
USER MANAGEMENT Layar User Management digunakan untuk melakukan manajemen terhadap user yang dapat mengakses WUI Stargate. Di layar ini, user yang sedang login dapat membuat user baru, serta mengedit atau menghapus user yang sudah ada.
Isian
Deskripsi
User ID
Diisi dengan teks yang akan digunakan user tersebut untuk login
Halaman 10/19
Equnix Business Solutions, PT
ke dalam WUI Stargate. User ID ini harus bersifat unik Real Name
Diisi dengan nama dari user tersebut
Password
Diisi kata sandi yang digunakan user tersebut untuk login ke dalam WUI Stargate
Confirm
Diisi dengan kata sandi yang sama dengan Password
Groups
Dipilih yang sesuai dengan hak akses yang ingin diberikan kepada user. Hak akses yang diberikan adalah gabungan dari group yang dipilih
Halaman 11/19
•
Group 1, dapat melihat Group dan Report
•
Group 2, dapat melihat Log
•
Group 3, dapat menghapus, mengedit dan mbuat Group serta menghapus, mengedit, melihat dan menambah modem
•
Group 4, dapat melihat dan mengedit konfigurasi, serta dapat membuat, mengedit, melihat, dan menghapus user
Equnix Business Solutions, PT
VIEW LOG Layar ini menampilkan log yang ditulis oleh Stargate dari waktu ke waktu. Log yang ditampilkan adalah log terbaru dan akan di-update dari waktu ke waktu sesuai dengan konfigurasi yang ditetapkan. System
Berisikan log yang ditulis ke file syslog.log. Log ini memuat berbagai log yang berkaitan dengan sistem Stargate. Apps
Halaman 12/19
Equnix Business Solutions, PT
Berisikan log yang ditulis ke file applog.log. Log ini membuat berbagai catatan yang berhubungan alur kerja Stargate.
Halaman 13/19
Equnix Business Solutions, PT
Activity
Berisikan log yang ditulis ke file actlog.log. Log ini memuat berbagai catatan yang berhubungan dengan aktivitas user dalam menggunakan Stargate.
Halaman 14/19
Equnix Business Solutions, PT
Report Stargate mendukung metode laporan dapat di customize sesuai dengan kebutuhan. Parameter Report Name akan menentukan ketersediaan dari parameter lainnya. Dengan demikian, tidak semua parameter dapat tersedia.
Parameter
Deskripsi
ReportName
berisi daftar dari jenis Report yang dapat dipilih
Periode
terdiri dari 2 isian, berupa tanggal mulai dan tanggal akhir
MSISDN
dapat diisi dengan parameter berupa nomor MSISDN yang ingin dicari
PIC
berisikan data user dan Inbound group
Group
berisikan data Inbound dan Outbound group
Reference No
dapat diisikan dengan reference number yang ingin dicari
Match Token
dapat diisi dengan Match Token yang ingin dicari
Halaman 15/19
Equnix Business Solutions, PT
Status
berisikan daftar status yang mungkin ada
Panel Kiri (Toolbar) Toolbar Deskripsi Memorize
Jika diaktifkan (warna merah), maka setiap pergantian tampilan Report tidak akan membuat report yang lama
Save to xls
Unduh laporan dalam format xls
Save to csv
Unduh laporan dalam format CSV
Help
Tampilkan informasi mengenai report yang dipilih
Membuat Report Sendiri Report dapat dibuat dengan langsung memasukkan data mengenai report tersebut ke dalam table rptmpl di database yang digunakan Stargate. Struktur dari table tersebut adalah Nama Jenis Deskripsi rptid
Int
Harus unik, digunakan sebagai penentu report yang akan ditampilkan penentu report yang akan ditampilkan
rptname
varchar(100)
Nama dari report
desc
Text
Keterangan mengenai report tersebut
sql
Text
Query SQL yang akan digunakan untuk mendapatkan hasil report, lihat penjelasan dibawah
creadate
timestamp
waktu pembuatan report
modidate
timestamp
waktu modifikasi report
acl
varchar(20)
Hak akses report
reporttype
varchar(10)
diisikan 'chart' jika report ini mengandung tampilan grafik
Halaman 16/19
Equnix Business Solutions, PT
Reporting SQL Kolom SQL pada tabel yang menyimpan report ini diisi dengan dengan parameter-parameter yang akan mengaktifkan isian pada layar Report di WUI Stargate. Keyword paramater yang tersedia adalah sebagai berikut $rangedate(a) akan menghasilkan a BETWEEN datestart AND dateend $msisdn(a)
akan menghasilkan a = 'MSISDN_VALUE'
$pic(a)
akan menghasilkan a = 'PIC_VALUE'
$group(a)
akan menghasilkan a = 'GROUP_VALUE'
$reffid(a)
akan menghasilkan a = 'REFF_NO_VALUE'
$matchToken(a)
akan menghasilkan a = 'MATCH_TOKEN_VALUE'
$status(a)
akan menghasilkan a = 'STATUS_VALUE'
Contoh penggunaan SQL Query
Query pada report
Deskripsi
SELECT smsid, mdmid, msisdn, msgtext, pulldate FROM tsmsin WHERE $msisdn(msisdn)
SELECT smsid, mdmid, xxx adalah sesuai dengan isian msisdn, msgtext, pada kolom MSISDN di WUI pulldate FROM tsmsin Stargate WHERE msisdn = 'xxx'
SELECT smsid, mdmid, msisdn, msgtext, pulldate FROM tsmsin WHERE $msisdn(msisdn) AND rangedate(pulldate)
SELECT smsid, mdmid, msisdn, msgtext, pulldate FROM tsmsin WHERE msisdn = 'xxx' AND pulldate BETWEEN 'yyyymm-dd' AND 'yyyy-mmdd_2'
xxx adalah sesuai dengan isian pada kolom MSISDN di WUI Stargate, yyyy-mm-dd dan yyyymm-dd_2 adalah isian di kolom periode (awal dan akhir)
Kirim SMS melalui media HTTP Stargate dapat diakses dengan media HTTP untuk keperluan pengiriman SMS. Metode akses Halaman 17/19
Equnix Business Solutions, PT
yang didukung adalah dengan menggunakan HTTP GET atau dengan POST format XML yang didukung. HTTP GET Kirim SMS dengan mengakses http://IP:PORT/apps/webserv.htppusername=inboundgroupuser&passwor d=inboundgrouppass&pinrequest=off&smsid=999&modemid=mymodem&to=08 1567890&text=my_message&timereq=05-04-2012 15:10:10
contoh response 081567890#05-04-2012 15:10:11#mymodem#0#Sukses XML (POST) Kirim SMS dengan mengakses url http://IP:PORT/apps/webserv.soap
dengan request POST berisikan
<soapenv:Envelope xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xsd=http://www.w3.org/2001/XMLSchema xmlns:soapenv=http://schemas.xmlsoap.org/soap/envelope/ xmlns:urn=urn:smsGateway> <soapenv:Header/> <soapenv:Body>
<smsServer xsi:type=urn:smsServer> 08167890 my message 05-04-2012 15:10:10 <modemid xsi:type=xsd:string>mymodem <smsid xsi:type=xsd:string>mymodem OFF
Halaman 18/19
Equnix Business Solutions, PT
<username xsi:type=xsd:string>inboundgroupuser <password xsi:type=xsd:string>inboundgrouppass
contoh response <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:smsGateway"> <SOAP-ENV:Body> <nsl:smsServerResponse xmlns:nsl="urn:smsGateway">
08167890 05-04-2012 15:10:11 <modemid>mymodem 0 Sukses
Halaman 19/19
Equnix Business Solutions, PT
Parameter untuk kirim SMS melalui HTTP GET maupun POST XML Field Format Keterangan to*
+62xxxxxxx
No handphone tujuan
text*
semua karakter
isi SMS
timereq*
DD-MM-YYYY HH:MM:SS
waktu pengiriman
modemid
alphanumeric
MODEM ID untuk menspesifikasikan dikirim dari modem mana
pinrequest
ON atau OFF
Pilihan pin request atau tidak
username*
semua karakter
username identifikasi client (Inbound group)
password*
semua karakter
username identifikasi client (Inbound group)
smsid numerik Tanda * berarti field yang wajib diisi.
Halaman 20/19
SMS id yang dikirimkan
Equnix Business Solutions, PT