Application¶

Data model¶

Customer structure

Contact and address

Services

Database tables¶

customer:

Storage of customers

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
name	varchar	N
status	integer	N	foreign key to lov_status.id
segment	integer	N	foreign key to lov_segment.id
birth_no	varchar	Y
reg_no	varchar	Y
tax_no	varchar	Y
create_date	datetime	Y
modify_date	datetime	Y

payer:

Storage of payers

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
name	varchar	N
status	integer	N	foreign key to lov_status.id
billcycle	integer	N	foreign key to lov_billcycle.id
bank_account	varchar	Y
customer	integer	N	foreign key to customer.id
create_date	datetime	Y
modify_date	datetime	Y

subscriber:

Storage of subscribers

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
name	varchar	N
msisdn	varchar	N
status	integer	N	foreign key to lov_status.id
market	integer	N	foreign key to lov_segment.id
tariff	varchar	N	foreign key to lov_tariff.id
customer	integer	N	foreign key to customer.id
payer	integer	N	foreign key to payer.id
create_date	datetime	Y
modify_date	datetime	Y

contact:

Storage of contacts

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
name	varchar	N
phone	varchar	Y
email	varchar	Y
create_date	datetime	Y
modify_date	datetime	Y

contact_role:

Storage of contact roles

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
contact_role	integer	N	foreign key to lov_contact_role.id
contact	integer	N	foreign key to contact.id
customer	integer	Y	foreign key to customer.id
payer	integer	Y	foreign key to payer.id
subscriber	integer	Y	foreign key to subscriber.id
create_date	datetime	Y

address:

Storage of addresses

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
street	varchar	N
street_no	varchar	N
city	varchar	N
zip	integer	N
create_date	datetime	Y
modify_date	datetime	Y

address_role:

Storage of address roles

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
address_role	integer	N	foreign key to lov_address_role.id
address	integer	N	foreign key to address.id
contact	integer	Y	foreign key to contact.id
customer	integer	Y	foreign key to customer.id
payer	integer	Y	foreign key to payer.id
subscriber	integer	Y	foreign key to subscriber.id
create_date	datetime	Y

service:

Storage of services

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
service	integer	N	foreign key to lov_service.id
status	integer	N	foreign key to lov_status.id
customer	integer	Y	foreign key to customer.id
payer	integer	Y	foreign key to payer.id
subscriber	integer	Y	foreign key to subscriber.id
create_date	datetime	Y
modify_date	datetime	Y

service_params:

Storage of service parameters

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
param	integer	N	foreign key to lov_service_param.id
value	varchar	Y
service	integer	N	foreign key to lov_service.id
create_date	datetime	Y
modify_date	datetime	Y

history:

Auditing table, operation with every entity is logged.

Column	Datatype	Nullable	Constraint
id	integer	N	primary key autoincrement
event_date	datetime	N
table_name	varchar	N
table_id	integer	N
event	varchar	N
log	clob	Y

lov_status:

List of statuses

Column	Datatype	Nullable	Constraint
id	integer	N	primary key
title	varchar	N

Following statuses are configured

id	title
1	active
2	deactive
3	suspend

lov_segment:

List of customer segments

Column	Datatype	Nullable	Constraint
id	integer	N	primary key
title	varchar	N

Following segment are configured

id	title
2	RES
3	VSE
4	SME
5	LE

lov_billcycle:

List of payer billcycles

Column	Datatype	Nullable	Constraint
id	integer	N	primary key
title	varchar	N

Following billcycles are configured

id	title
1	51
2	52
3	53
4	54

lov_market:

List of subscriber markets

Column	Datatype	Nullable	Constraint
id	integer	N	primary key
title	varchar	N

Following statuses are configured

id	title
1	GSM
2	DSL
3	FIX

lov_tariff:

List of subscriber tariffs

Column	Datatype	Nullable	Constraint
id	integer	N	primary key
title	varchar	N
segment	integer	Y
market	integer	Y
monthly_fee	integer	Y

Following tariffs are configured

id	title
433	S nami sit nesit
459	S nami sit nesit bez zavazku
434	S nami sit nesit v podnikani
460	S nami sit nesit v podnikani bez zavazku

lov_contact_role:

List of contact roles

Column	Datatype	Nullable	Constraint
id	integer	N	primary key
title	varchar	N

Following roles are configured

id	title
1	contact
2	contract
3	invoicing

lov_address_role:

List od address roles

Column	Datatype	Nullable	Constraint
id	integer	N	primary key
title	varchar	N

Following roles are configured

id	title
1	contact
2	contract
3	invoicing
4	delivery

lov_service:

List of services

Column	Datatype	Nullable	Constraint
id	integer	N	primary key
title	varchar	N
monthly_fee	integer	Y
customer	integer	Y
payer	integer	Y
subscriber	integer	Y

Following services are configured

id	title	customer	payer	subscriber
615	Telefonni cislo	0	0	1
619	SIM karta	0	0	1

lov_service_param:

List of service parameters

Column	Datatype	Nullable	Constraint
id	integer	N	primary key
title	varchar	N
service	integer	N	foreign key to lov_service.id
default_value	varchar	Y
mandatory	integer	Y

Following parameters are configured

Following statuses are configured

id	title	service	mandatory
121	MSISDN	615	1
122	ICCID	619	1
123	IMSI	619	1

GUI application¶

Customer structure

id	element id	description
1	customerId	Mandatory for read, change. Stored in CUSTOMER.ID
2	customerName	Mandatory for create. Stored in CUSTOMER.NAME
3	customerStatus	Mandatory for create. Stored in CUSTOMER.STATUS
4	customerSegment	Mandatory for create. Stored in CUSTOMER.SEGMENT
5	customerBirthNumber	Optional. Stored in CUSTOMER.BIRTH_NO
6	customerRegistrationNumber	Optional. Stored in CUSTOMER.REG_NO
7	customerTaxNumber	Optional. Stored in CUSTOMER.TAX_NO
8	customerError	Filled if any error occurs.
9	customerRead	Calls read_customer and fills elements.
10	customerCreate	Calls create_customer and fills customerId.
11	customerChange	Calls change_customer.
12	payerId	Mandatory for read, change. Stored in PAYER.ID
13	payerName	Mandatory for create. Stored in PAYER.NAME
14	payerStatus	Mandatory for create. Stored in PAYER.STATUS
15	payerBillcycle	Mandatory for create. Stored in PAYER.BILLCYCLE
16	payerBankAccount	Optional. Stored in PAYER.BANK_ACCOUNT
17	payerCustomer	Mandatory for create. Stored in PAYER.CUSTOMER
18	payerError	Filled if any error occurs.
19	payerRead	Calls read_payer and fills elements.
20	payerCreate	Calls create_payer and fills payerId.
21	payerChange	Calls change_payer.
22	subscriberId	Mandatory for read, change. Stored in SUBSCRIBER.ID
23	subscriberName	Mandatory for create. Stored in SUBSCRIBER.NAME
24	subscriberMsisdn	Mandatory for create. Stored in SUBCSRIBER.MSISDN
25	subscriberStatus	Mandatory for create. Stored in SUBSCRIBER.STATUS
26	subscriberMarket	Mandatory for create. Stored in SUBSCRIBER.MARKET
27	subscriberTariff	Mandatory for create. Stored in SUBSCRIBER.TARIFF
28	subscriberCustomer	Mandatory for create. Stored in SUBSCRIBER.CUSTOMER
29	subscriberPayer	Mandatory for create. Stored in SUBSCRIBER.PAYER
30	subscriberError	Filled if any error occurs.
31	subscriberRead	Calls read_subscriber and fills elements.
32	subscriberCreate	Calls create_subscriber and fills subscriberId.
33	susbcriberChange	Calls change_subscriber.

Contact and address

id	element id	description
1	contactId	Mandatory for read, change. Stored in CONTACT.ID, CONTACT_ROLE.CONTACT
2	contactName	Mandatory for create. Stores in CONTACT.NAME
3	contactPhone	Optional. Stored in CONTACT.PHONE
4	contactEmail	Optional. Stored in CONTACT.EMAIL
5	contactError	Filled if any error occurs.
6	contactRead	Calls read_contact and fills elements.
7	contactCreate	Calls create_contact and fills contactId.
8	contactChange	Calls change_contact.
9	contactRoleTitle	Mandatory for assign, revoke. Stored in CONTACT_ROLE.CONTACT_ROLE
10	contactRoleCustomer	Optional. Stored in CONTACT_ROLE.CUSTOMER
11	contactRolePayer	Optional. Stored in CONTACT_ROLE.PAYER
12	contactRoleSubscriber	Optional. Stored in CONTACT_ROLE.SUBSCRIBER
13	contactRoleError	Filled if any error occurs.
14	contactRoleAssign	Calls assign_contact_role and updates contactRoles.
15	contactRoleRevoke	Calls revoke_contact_role and updates contactRoles.
16	contactRoles	Display CONTACT_ROLE content. Click cell event fills contactRole elements.
17	addressId	Mandatory for read, change. Stored in ADDRESS.ID
18	addressStreet	Mandatory for create. Stored in ADDRESS.STREET
19	addressStreetNumber	Mandatory for create. Stored in ADDRESS.STREET_NO
20	addressCity	Mandatory for create. Stored in ADDRESS.CITY
21	addressZip	Mandatory for create. Stored in ADDRESS.ZIP
22	addressError	Filled if any error occurs.
23	addressRead	Calls read_address and fills elements.
24	addressCreate	Calls create_address and fills addressId.
25	addressChange	Calls change_address.
26	addressRoleTitle	Mandatory for assign, revoke. Stored in ADRESS_ROLE.ADDRESS_ROLE
27	addressRoleContact	Optional. Stored in ADDRESS_ROLE.CONTACT
28	addressRoleCustomer	Optional. Stored in ADDRESS_ROLE.CUSTOMER
29	addressRolePayer	Optional. Stored in ADDRESS_ROLE.PAYER
30	addressRoleSubscriber	Optional. Stored in ADDRESS_ROLE.SUBSCRIBER
31	addressRoleError	Filled if any error occurs.
32	addressRoleAssign	Calls assign_address_role and updates addressRoles.
33	addressRoleRevoke	Calls revoke_address_role and updates addressRoles.
34	addressRoles	Display ADDRESS_ROLE content. Click cell event fills addressRole elements.

entities¶

Module provides classes for all entities modeled in database.

• Customer - table customer
• Payer - table payer
• Subscriber - table subscriber
• Contact - table contact
• ContactRole - table contact_role
• Address - table address
• AddressRole - table address_role
• Service - tables service, service_params
• ServiceOperation - auxiliary class for manipulation with service

Each class implements same methods.

• __init__ - set all attributes
• __str__ - serialization to string
• toxml - serialization to xml object (lxml.etree)
• tojson - serialization to json string

db_handler¶

Module provides interface for database implemented in SQLite. It uses module hydratk.lib.network.dbi.client which is automatically installed.

Attributes :

• _mh - MasterHead reference
• _db_file - database filename
• _client - DBClient instance

Methods :

• connect

Method connects to database.

• disconnect

Method disconnect from database.

• get_lov

Method reads LOV from database.

• customer

Methods for manipulation with customer entity. Method read_customer selects from table customer. Method create_customer inserts to tables customer and history, status is translated to id from table lov_status. Method change_customer updates in table customer and inserts to history.

• payer

Methods for manipulation with payer entity. Method read_payer selects from table payer. Method create_payer inserts to tables payer and history, status is translated to id from table status. Method change_payer updates in table payer and inserts to history.

• subscriber

Methods for manipulation with subscriber entity. Method read_subscriber selects from table subscriber. Method create_subscriber inserts to tables subscriber and history, status is translated to id from table status. Method change_subscriber updates in table subscriber and inserts to history.

• contact

Methods for manipulation with contact entity. Method read_contact selects from table contact and contact_role (if assigned). Role titles are translated from table lov_contact_role. Method create_contact inserts to tables contact and history. Method change_contact updates in table contact and inserts to history. Method assign_contact_role inserts to tables contact_role and history. Method revoke_contact_role deletes from table contact_role and inserts to history.

• address

Methods for manipulation with address entity. Method read_address selects from table address and address (if assigned). Role titles are translated from table lov_address_role. Method create_address inserts to tables address and history. Method change_address updates in table address and inserts to history. Method assign_address_role inserts to tables address_role and history. Method revoke_address_role deletes from table address_role and inserts to history.

• service

Methods for manipulation with service entity. Method read_services selects from tables service and service_params. Method creates_service inserts to tables service, service_params and history. It checks whether service is allowed for customer,payer,subscriber in table lov_service and checks if service is already assigned in table service. It reads allowed and mandatory parameters from table lov_service_param. Method change_service updates in tables service and service_params and inserts to history.

web_server¶

Module provides web server with REST and SOAP services implemented using external module web.py in version >= 0.37. When Python3 is used the module replaced by different branch py3.

Module contains several classes.

• Server

Starts web server on configured IP address (0.0.0.0) and port (default 8888) using web.py methods application, runsimple, wsgifunc.

• Index

Handles GET, POST requests on / and routes them to GuiHandler.

• Customer

Handles GET, POST, PUT requests on /rs/customer and routes them to RestHandler.

• Payer

Handles GET, POST, PUT requests on /rs/payer and routes them to RestHandler.

• Subscriber

Handles GET, POST, PUT requests on /rs/subscriber and routes them to RestHandler.

• Contact

Handles GET, POST, PUT requests on /rs/contact and routes them to RestHandler.

• ContactRole

Handles POST, PUT requests on /rs/contact/role and routes them to RestHandler.

• Address

Handles GET, POST, PUT requests on /rs/address and routes them to RestHandler.

• AddressRole

Handles POST, PUT requests on /rs/address/role and routes them to RestHandler.

• Service

Handles GET, POST, PUT requests on /rs/service and routes them to RestHandler.

• SoapService

Handles GET, POST requests on /ws/crm. GET request returns content of WSDL (crm.wsdl) or XSD (crm.xsd) if URL parameter wsdl of xsd is provided. File location is configured. POST request is routed to SoapHandler.

RestHandler¶

Module provides class RestHandler with REST service. Each entity method uses appropriate method in DbHandler. It uses simplejson method loads to read JSON and entity method tojson to write JSON.

Attributes :

• _mh - MasterHead reference

Methods :

• __init__

Method sets MasterHead reference.

• _get_db

Method gets initializes DbHandler and connects to database.

• customer

Methods for manipulation with customer entity - read_customer, create_customer, change_customer.

• payer

Methods for manipulation with payer entity - read_payer, create_payer, change_payer.

• subscriber

Methods for manipulation with subscriber entity - read_subscriber, create_subscriber, change_subscriber.

• contact

Methods for manipulation with contact entity - read_contact, create_contact, change_contact, assign_contact_role, revoke_contact_role.

• address

Methods for manipulation with address entity - read_address, create_address, change_address, assign_address_role, revoke_address_role.

• service

Methods for manipulation with service entity - read_services, create_service, change_service.

SoapHandler¶

Module provides class SoapHandler with SOAP service. Each entity method uses appropriate method in DbHandler. It uses lxml method objectify.fromstring to read XML entity method toxml and lxml method tostring to write XML.

Attributes :

• _mh - MasterHead reference
• _nsmap - namespace map
• _ns0 - SOAP namespace
• _ns1 - application namespace

Methods :

• __init__

Method sets MasterHead reference and namespaces.

• _get_db

Method gets initializes DbHandler and connects to database.

• _fault

Method prepares SOAP Fault response.

• _response

Method prepares SOAP standard response.

• dispatcher

Method dispatches request according to HTTP header SOAPAction.

• customer

Methods for manipulation with customer entity - read_customer, create_customer, change_customer.

• payer

Methods for manipulation with payer entity - read_payer, create_payer, change_payer.

• subscriber

Methods for manipulation with subscriber entity - read_subscriber, create_subscriber, change_subscriber.

• contact

Methods for manipulation with contact entity - read_contact, create_contact, change_contact, assign_contact_role, revoke_contact_role.

• address

Methods for manipulation with address entity - read_address, create_address, change_address, assign_address_role, revoke_address_role.

• service

Methods for manipulation with service entity - read_services, create_service, change_service.

GuiHandler¶

Module provides class GuiHandler with GUI application. Each entity method uses appropriate method in DbHandler. It uses lxml method objectify.fromstring to read XML entity method toxml and lxml method tostring to write XML.

Attributes :

• _mh - MasterHead reference
• _tmpl - html template
• _lovs - loaded database LOVs
• _data - current form data (used to fill forms after action)
• _current_tab - current tab

Methods :

• __init__

Method sets MasterHead reference and namespaces.

• _get_db

Method gets initializes DbHandler and connects to database.

• _init_data

Method sets initial form data.

• _store_data

Method sets current form data updated after each action.

• _translate_lov

Method translates record ID <-> title.

• render_page

Method renders application page and fills forms with current data (updated after each action).

• _init_customer_form

Method prepares customer form.

• _init_payer_form

Method prepares payer form.

• _init_subscriber_form

Method prepares subscriber form.

• _init_contact_form

Method prepares contact form.

• _init_contact_role_form

Method prepares contact roles form.

• _init_address_form

Method prepares address form.

• _init_address_role_form

Method prepares address roles form.

• customer

Methods for manipulation with customer entity - read_customer, create_customer, change_customer.

• payer

Methods for manipulation with payer entity - read_payer, create_payer, change_payer.

• subscriber

Methods for manipulation with subscriber entity - read_subscriber, create_subscriber, change_subscriber.

• contact

Methods for manipulation with contact entity - read_contact, create_contact, change_contact, assign_contact_role, revoke_contact_role.

• address

Methods for manipulation with address entity - read_address, create_address, change_address, assign_address_role, revoke_address_role.

Unit tests¶

Application modules have no specific unit tests. Extension TestEnv also serves as tutorial how to write test libraries/helpers and scripts for Yoda extension. These scripts are used as unit tests.

lib :

• db_int

Module provides class DB_INT with methods to test all operations in database. The methods directly call appropriate DBHandler methods.

• gui_int

Module provides class GUI_INT with methods to test all operations in GUI application. It uses hydratk.lib.bridge.selen.SeleniumBridge.

• rest_int

Module provides class REST_INT with methods to test all operations in REST service. It uses hydratk.lib.network.rest.client.RESTClient.

• soap_int

Module provides class SOAP_INT with methods to test all operations in SOAP service. It uses hydratk.lib.network.rest.client.SOAPClient.

helpers :

• helpers

Imports libraries DB_INT, GUI_INT, REST_INT, SOAP_INT to be accessible in test scripts.

tests :

• db

  # initialize client
  import yodahelpers.hydratk.extensions.testenv.helpers as hlp
  client = hlp.db()
  res = client.connect()
  
  # create customer
  name = 'Vince Neil'
  status = 'active'
  segment = 2
  birth_no = '700101/0001'
  reg_no = '12345'
  tax_no = 'CZ12345'
  cust = client.create_customer(name, segment, status, birth_no, reg_no, tax_no)
  customer = client.read_customer(cust)
  

• rest

  # initialize client
  import yodahelpers.hydratk.extensions.testenv.helpers as hlp
  client = hlp.rest()
  
  # create customer
  name = 'Vince Neil'
  status = 'active'
  segment = 2
  birth_no = '700101/0001'
  reg_no = '12345'
  tax_no = 'CZ12345'
  cust = client.create_customer(name, segment, status, birth_no, reg_no, tax_no)
  customer = client.read_customer(cust)
  

• soap

  # initialize client
  import yodahelpers.hydratk.extensions.testenv.helpers as hlp
  client = hlp.soap()
  
  # create customer
  
  name = 'Vince Neil'
  status = 'active'
  segment = 2
  birth_no = '700101/0001'
  reg_no = '12345'
  tax_no = 'CZ12345'
  cust = client.create_customer(name, segment, status, birth_no, reg_no, tax_no)
  customer = client.read_customer(cust)
  

• gui

  # initialize client
  import yodahelpers.hydratk.extensions.testenv.helpers as hlp
  client = hlp.gui()
  res = client.open()
  
  # create customer
  name = 'Vince Neil'
  status = 'active'
  segment = 'RES'
  birth_no = '700101/0001'
  reg_no = '12345'
  tax_no = 'CZ12345'
  cust = client.create_customer(name, segment, status, birth_no, reg_no, tax_no)
  customer = client.read_customer(cust)