Revision: 1.1
This document contains confidential information, which is property of Telepin Software. No part of its contents may be used, copied,
disclosed or conveyed to any party in any manner whatsoever without prior written permission from Telepin Software.
Copyright 2009 Telepin Software Corporation. All Rights Reserved.
Telepin Software
Rev. 1.1
Table of Contents
1
INTRODUCTION ........................................................................................................................................ 1
2.3
3
AVAILABLE VIEWS................................................................................................................................... 7
3.1
VIEW WINDOW ...............................................................................................................................................7
3.1.1
Configuring the view window ................................................................................................................7
3.1.2
Determining the actual date range ........................................................................................................7
3.1.3
List partitions covered by view window .................................................................................................8
3.2
BASE VIEWS ...................................................................................................................................................8
3.2.1
Base views in view window ....................................................................................................................8
3.2.2
Dynamic creation of base views ............................................................................................................9
3.3
PRODUCTION VIEWS .......................................................................................................................................9
3.3.1
V$$ACCOUNTUSERS ...........................................................................................................................9
3.3.2
V$$BRANDSDAILYREPORT ..............................................................................................................10
3.3.3
V$$CREDIT_TRANSFER ....................................................................................................................10
3.3.4
V$$CUSTOMER_QUOTA_TOPUPS ..................................................................................................11
3.3.5
V$$DCLTOPUPS ................................................................................................................................12
3.3.6
V$$DCLTRANSFERS ..........................................................................................................................12
3.3.7
V$$FINANCIAL_ACTIVITY ................................................................................................................13
3.3.8
V$$NUMBEROFTX .............................................................................................................................13
3.3.9
V$$OWNERBRANDSDAILYREPORT.................................................................................................14
3.3.10
V$$PDVA.............................................................................................................................................14
3.3.11
V$$QUOTA_CREDIT_TRANSFERES ................................................................................................14
3.3.12
V$$REFUNDSALESORDER ...............................................................................................................15
3.3.13
V$$SALESTRANSACTION ..................................................................................................................15
Page ii
Telepin Software
Rev. 1.1
Page iii
Index of Figures
No table of figures entries found.
Index of Tables
No table of figures entries found.
Telepin Software
Rev. 1.1
1 Introduction
Telepin is the commercial name for Telepin Software offering of on-demand purchase of electronic topup and value added switch for mobile operator. This document explains the
Telepin data extractor tool (TDX). TDX is part of the Telepin Admin suite and is used to exact generic data in XML, comma separated values (CSV) Excel format, and/or tab format (text). TDX gives the operator
the ability to define the target databases views and the selection criteria and generates extract descriptors. It enables the operator to write his own extract descriptors in simple XML format. The tool can run
interactively. This tool can be easily used to extract daily transaction for the operator data warehouse,
and proves to be a valuable tool for market analysis and research.
In this manual, the user will have an overview on how to use TDX in day-today operation and learn how
to build the report template. In addition, the manual contains a full description for the TDX views in the
database, which explain in the last chapter.
2 Getting Started
In order to login and use TDX tool, the user has to have the TDX privilege in the users access role. Run
the start.bat located in the local TDX home directory to start TDX and type username/password.
A drop-down menu enables the user to extract a report or create a new report template.
Page 1
Telepin Software
Rev. 1.1
Field/Button
Description
Browse
Quick Set
Quick Set is list of all the predefined report templates. A user can easily
choose one of the report templates to generate the report. All report
templates are stored in the xml directory located in the local TDX home
directory. In addition, the user always has the option to view or edit the
xml report template.
Select Quick Set button ~ Quick Set page appears.
Format
The data results can be saved as XML, CSV or tab format. The user must
Proprietary Information subject to restrictions on cover page
Page 2
Telepin Software
Rev. 1.1
The report results and output files are stored in the target output directory. If the output directory is not set, then all results will be stored in
the output directory located in the local home directory of the TDX.
Log
Customize Output
This feature is not supported in the current version of TDX tool. Generate to start generate the report.
Generate
Clear Log
That allows the user to monitor the report processing steps. The user
can always press clear log button to clear the log.
Clear Output
Close
2.1.1
Quick Set
This section explains the page that appears when the Quick Set button is selected from the Data Extract
page.
Field/Button
Description
Select
View
Page 3
Telepin Software
Edit
Cancel
Rev. 1.1
Page 4
Telepin Software
2.2.1
Rev. 1.1
Descriptor Editor
In the Descriptor Editor, the Operator is able to create the report template from available database
views. All views of the TDX start with V$$ i.e. V$$ACCOUNTUSERS (refer to Chapter 3 for more detail
about V$$ database views).
Field/Button
Description
Select View
Available Columns
Selected Columns
Conditions
Page 5
Telepin Software
Operators
Value 1
Rev. 1.1
Save As
The report template is saved by default into the xml directory located
in the local TDX home directory unless otherwise specified by the user.
Save
Close
Page 6
Telepin Software
Rev. 1.1
3 Available Views
This chapter describes all V$$ views available for the Telepin Cayman Platform database.
The view period can be configured by setting the newly added view_report_begin and view_report_end
fields in the SYSTEM_CONFIGURATION table. Here are the column definitions:
Column
Type
Description
VIEW_REPORT_BEGIN
NUMBER
VIEW_REPORT_END
NUMBER
The view window covers the time from TRUNC (SYSDATE-[VIEW_REPORT_BEGIN]) to TRUNC (SYSDATE[VIEW_REPORT_END]).
For example, when VIEW_REPORT_BEGIN=2, VIEW_REPORT_END=0, it means the view window covers
the time from TRUNC (SYSDATE-2) to TRUNC (SYSDATE-0). The view will cover data from yesterday and
the day before yesterday.
The view window is calculated by the V$$DATE_RANGE view, which is described in the next section.
3.1.2
The actual date range can be determined by V$$DATE_RANGE view derived from the values of
VIEW_REPORT_BEGIN and VIEW_REPORT_END columns in SYSTEM_CONFIGURATION table. The
V$$DATE_RANGE view provides the following information:
Column
Type
Description
DATE_BEGIN
DATE
DATE_END
DATE
KEY_MONTH_BEGIN
NUMBER
KEY_MONTH_END
NUMBER
KEY_DAY_BEGIN
NUMBER
KEY_DAY_END
NUMBER
Page 7
Telepin Software
3.1.3
Rev. 1.1
Two new views will list all the partition values covered by the view window for both MONTH partitions
and DAY partitions between DATE_BEGIN and DATE_END of V$$DATE_RANGE view. These views are:
V$$MONTH_LIST view
Column
Type
Description
MONTH_NUMBER
NUMBER
Column
Type
Description
DAY_NUMBER
NUMBER
V$$DAY_LIST view
Type
Description
MONTH_NUMBER
NUMBER
Month number
DAY_NUMBER
NUMBER
Day number
This table simply lists all the possible month and day values over the year, from Jan 01 through Dec 31. It
contains 366 rows, and should be read-only all the time.
The following views on the partitioned tables covering only the data within the partitions in the view
window:
View Name
Base Table
V$$SALES_ORDER
SALES_ORDER
V$$SALES_ORDER_DETAILS
SALES_ORDER_DETAILS
V$$PIN
PIN
V$$SALES_ORDER_DETAILS_PARTITI
SALES_ORDER_DETAILS_PARTITION
V$$SALES_ORDER_DEDICATED_ACCOU
SALES_ORDER_DEDICATED_ACCOUNT
Page 8
Telepin Software
Rev. 1.1
In the production views, these views will replace the base tables.
3.2.2
A database job is scheduled daily at midnight to automatically recreate the base views to keep up-todate to the view window. The job calls a stored procedure REFRESH_PART_VIEWS. The procedure automatically detects the Monthly and Daily Partitioning scheme and makes the base views to cover the
appropriate partitions.
Required system privileges for the user:
CREATE JOB
CREATE VIEW
V$$ACCOUNTUSERS
The view contains all necessary information of the accounts and account creation date. This report can
be used to extract information about specific accounts, run daily or weekly report to show the new accounts, or/and list all accounts on a specific layer or group. Varity of templates with different business
needs can be designed for this view. The view columns are:
Column
Type
Description
CURRENT_DATE
DATE
ACCOUNT_ID
ACCOUNT_NAME
Account Name
USER_ID
NUMBER(100)
CITY_ID
NUMBER(10)
City ID
CITY_NAME
VARCHAR2(30)
City Name
PROVINCE_NAME
VARCHAR2(30)
Province Name
ADDRESS
VARCHAR2(300)
Account Address
CONTACT_NAME
VARCHAR2(200)
ACCOUNT_MOBILE
VARCHAR2(15)
OWNER_ID
NUMBER(10)
DISCOUNT_PERCENT
NUMER(6,3)
DATE_CREATED
DATE
Page 9
Telepin Software
Rev. 1.1
UNIVERSAL_ID
VARCHAR2(30)
Accounts Universal ID
CURRENT_BALANCE
NUMBER
USER_NAME
VARCHAR2(30)
ACCESS_TYPE
VARCHAR2(3)
ROLE_NAME
VARCHAR2(50)
GROUP_ID
NUMBER(3)
GROUP_NAME
VARCHAR2(100)
LAYER_NAME
VARCHAR2(30)
LAYER_ID
NUMBER(10)
LANGUAGE
VARCHAR2(1)
3.3.2
V$$BRANDSDAILYREPORT
The view is a daily report that groups the number of transactions by brand and city. This report can be
used to extract sales information, customer behavioral, and information about top selling denominations and hot market spots. The report has to run for the past days in order to get accurate information.
Varity of templates with different business needs can be designed for this view. The view columns are:
Column
Type
Description
BRAND_NAME
VARCHAR2(100)
PROVINCE_NAME
VARCHAR2(30)
Province Name
CITY_NAME
VARCHAR2(30)
City Name
DAILY_DATE
DATE
Target day
NUMEROFTX
NUMBER
Number of Transactions.
3.3.3
V$$CREDIT_TRANSFER
Type
Description
TRANSACTION_ID
NUMBER(15)
Transaction ID
ACCOUNT_FROM_ID
ACCOUNT_FROM
Page 10
Telepin Software
Rev. 1.1
ACCOUNT_FROM_MOBILE
VARCHAR2(15)
ACCOUNT_TO_ID
ACCOUNT_TO
ACCOUNT_TO_MOBILE
VARCHAR2(15)
TRANSFERE_DATE
AMOUNT
NUMBER
3.3.4
V$$CUSTOMER_QUOTA_TOPUPS
The view contains all necessary information of the daily money transactions. This report can be used to
extract information about daily money flow (transfer or sales) within the system. This report cant be
used for reconciliation since the information is calculated daily starting from 00:00:01 till the moment of
the report creation and the account balance is showing the accumulated current balance. The report has
to run for the past days in order to get accurate information. Varity of templates with different business
needs can be designed for this view. The view columns are:
Column
Type
Description
ACCOUNT_ID
UNIVERSAL_ID
VARCHAR2(30)
Accounts Universal ID
ACCOUNT_NAME
Account Name
LEVEL_NAME
VARCHAR2(30)
GROUP_NAME
VARCHAR2(100)
MOBILE_NUMBER
VARCHAR2(15)
CONTACT
VARCHAR2(200)
OWNER_ID
NUMBER(10)
ADDRESS
VARCHAR2(300)
Account Address
PROVINCE
VARCHAR2(30)
Province Name
CITY_NAME
VARCHAR2(30)
City Name
BALANCE
NUMBER
RECEIVED_QUOTA
NUMBER
TRANSFERRED_QUOTA
NUMBER
TOPUP_AMOUNT
NUMBER
Page 11
Telepin Software
3.3.5
Rev. 1.1
V$$DCLTOPUPS
The view lists the decline sales (Topup) transactions with the specific error message and date. In order
to create useful template from the view, date should be constrained from/to for having daily or weekly
report. Varity of templates with different business needs can be designed for this view. The view columns are:
Column
Type
Description
TRANSACTION_DATE
DATE
TRANSACTION_ID
NUMBER(10)
Transaction ID
ACCOUNT_ID
NUMBER(10)
Account ID
ACCOUNT_NAME
VARCHAR2(200)
Account Name
AMOUNT
NUMER(10,3)
ERROR_CODE
VARCHAR2(260)
USER_NAME
VARCHAR2(100)
ACCESS_TYPE
VARCHAR2(20)
OWNER_ID
NUMBER(10)
MSISDN
VARCHAR2(20)
ACCOUNT_MOBILE
VARCHAR2(15)
BRAND_NAME
VARCHAR2(100)
3.3.6
V$$DCLTRANSFERS
The view lists the decline transfer transactions with their specific error message and date. In order to
create useful template from the view, date should be constrained from/to for having daily or weekly
report. Varity of templates with different business needs can be designed for this view. The view columns are:
Column
Type
Description
TRANSFER_DATE
AGENT_ID
NUMBER(10)
Agent (Sender) ID
CUSTOMER_ID
NUMBER(10)
Customer (Receiver) ID
QUOTA
NUMER(15,3)
LOG_MESSAGE
VARCHAR2(1000)
CUSTOMER_NAME
VARCHAR2(200)
Page 12
Telepin Software
CUSTOMER_MOBILE_NUMBER
VARCHAR2(15)
AGENT_NAME
VARCHAR2(200)
AGENT_MOBILE_NUMBER
VARCHAR2(15)
CUSTOMER_OWNER_ID
NUMBER(10)
Customers Owner ID
AGENT_OWNER_ID
NUMBER(10)
Agents Owner ID
3.3.7
Rev. 1.1
V$$FINANCIAL_ACTIVITY
Type
Description
TRANSACTION_DATE
DATE
CUSTOMER_NAME
VARCHAR2(200)
DESCRIPTION
VARCHAR2(29)
CREDIT
NUMBER
DEBIT
NUMBER
STATUS
VARCHAR2(4)
BALANCE_AFTER
NUMBER
3.3.8
V$$NUMBEROFTX
The view is a daily report that groups the total sale by user and city. This report can be used to extract
sales information about agent sales activity and information about most active point of sale and hot
market spots. The report has to run for the past days in order to get accurate information. Varity of
templates with different business needs can be designed for this view. The view columns are:
Column
Type
Description
CITY_NAME
VARCHAR2(30)
City Name
PROVINCE_NAME
VARCHAR2(30)
Province Name
OWNER_ID
NUMBER(10)
Account Owner ID
USER_NAME
VARCHAR2(30)
Page 13
Telepin Software
DAILY_DATE
DATE
Target day
NUMEROFTX
NUMBER
Number of Transactions.
AMOUNT
NUMBER
3.3.9
Rev. 1.1
V$$OWNERBRANDSDAILYREPORT
Type
Description
OWNER_ID
NUMBER(10)
Account Owner ID
BRAND_NAME
VARCHAR2(100)
PROVINCE_NAME
VARCHAR2(30)
Province Name
CITY_NAME
VARCHAR2(30)
City Name
DAILY_DATE
DATE
Target day
NUMEROFTX
NUMBER
Number of Transactions.
3.3.10 V$$PDVA
The view columns are:
Column
Type
Description
CUSTOMER_ID
NUMBER(10)
Customer (Receiver) ID
CUSTOMER_NAME
VARCHAR2(200)
3.3.11 V$$QUOTA_CREDIT_TRANSFERES
The view is a daily report showing the money transfer activities between agents. The report has to run
for the past days in order to get accurate information. Varity of templates with different business needs
can be designed for this view. The view columns are:
Column
Type
Description
DAILY_DATE
DATE
Target day
AGENT_ID
NUMBER(10)
Agent (Sender) ID
AGENT_NAME
VARCHAR2(200)
AGENT_MOBILE
VARCHAR2(15)
AGENT_CITY
VARCHAR2(30)
AGENT_PROVINCE
VARCHAR2(30)
Page 14
Telepin Software
AGENT_OWNER_ID
NUMBER(10)
Agents Owner ID
CUSTOMER_OWNER_ID
NUMBER(10)
Customers Owner ID
CUSTOMER_ID
NUMBER(10)
Customer (Receiver) ID
CUSTOMER_NAME
VARCHAR2(200)
CUSTOMER_MOBILE
VARCHAR2(15)
CUSTOMER_CITY
VARCHAR2(30)
CUSTOMER_PROVINCE
VARCHAR2(30)
AMOUNT
NUMBER
Rev. 1.1
3.3.12 V$$REFUNDSALESORDER
The view lists the refunded sales (Topup) transactions with the specific reason and date. In order to
create useful template from the view, date should be constrained from/to for having daily or weekly
report. Varity of templates with different business needs can be designed for this view. The view columns are:
Column
Type
Description
TRANSACTION_ID
NUMBER(10)
TRANSACTION_DATE
DATE
Transaction date.
ACCOUNT_ID
NUMBER(10)
Account ID
ACCOUNT_NAME
VARCHAR2(200)
Account Name
OWNER_ID
NUMBER(10)
ACCESS_TYPE
VARCHAR2(20)
USER_NAME
VARCHAR2(100)
SUB_MSISDN
VARCHAR2(20)
AMOUNT
NUMBER(10,3)
REFUND_REASON
VARCHAR2(100)
Refunded Reason
3.3.13 V$$SALESTRANSACTION
The view lists all sales (Topup) transactions declined, posted, hold...etc. for all or specific account. In
order to create useful template from the view, date should be constrained from/to for having daily or
weekly report. Varity of templates with different business needs can be designed for this view. The view
columns are:
Column
Type
Description
Page 15
Telepin Software
Rev. 1.1
TRANSACTION_DATE
DATE
Transaction date.
TRANSACTION_ID
NUMBER(10)
GROUP_ID
NUMBER(3)
GROUP_NAME
VARCHAR2(100)
LAYER_ID
NUMBER(10)
LAYER_NAME
VARCHAR2(30)
ACCOUNT_ID
NUMBER(10)
Account ID
ACCOUNT_NAME
VARCHAR2(200)
Account Name
AMOUNT
NUMBER(10,3)
Topup Amount
ERROR_CODE
VARCHAR2(260)
Error Code
USER_NAME
VARCHAR2(100)
ACCESS_TYPE
VARCHAR2(20)
OWNER_ID
NUMBER(10)
MSISDN
VARCHAR2(20)
ACCOUNT_MOBILE
VARCHAR2(15)
BRAND_NAME
VARCHAR2(100)
STATUS
VARCHAR2(4)
Transaction Status
Page 16