This article has been archived.
These steps will guide the user in the process of setting up the Network, Client Services, and Suspension.
Table of Contents
This guide focuses on setting up your network entities in UCRM. You will learn what entities can be set in UCRM and what their purpose is.
Basically, you need to set up two sections:
- Your core network (sites, gateway routers, edge (boundary) routers and other devices except CPEs)
- Client services (CPEs)
Finally, you will be able to link a client service to a router and its interface, which will also enable you to start using the suspension feature.
How to Set Up Network, Client Services and Suspension
1. Create Site. Site is a location of your core routers, e.g. a tower. Do so under Network > Sites.
2. Add New Device under Network > Devices. Within a site you can add some devices (i.e. routers) - all your core network devices located on the given site. (No CPE devices should be set here).
To enable the suspension synchronization script to communicate with this device you should:
- Provide username and password (in device settings)
- Provide device vendor name (in device settings)
- Add at least one accessible IP address (in device interface settings)
NOTE: Only EdgeRouters and Mikrotik routers are supported.
3. Provide the System IP under System > Settings >Application. This IP should point to the server where the UCRM application is located. All suspended clients are redirected to this server on port 81 by default, unless you have changed this default port manually in your UCRM system settings and docker container, for example to port 8081.
4. Create Client Service under Client Details > Services. When creating a new client service select a service plan and provide price, location, etc. So far, UCRM does not manage client devices. UCRM just needs to know what IP address is used by the client device to be connected to your core network device & interface. That's why not only the billing attributes are important to be set. You have to set also these attributes within the client service form:
- Interface - connected to - see Step 5
- Service IP - see Step 6
5. Link Client Service to a Device in your Network under Client Details > Service > Edit. In the service settings, choose a device and interface to which the service is connected to. This will enable the system to recognize which device should be synchronized in case of the suspension.
6. Define the Service IP under Client Details > Service > Edit. This will enable the system to recognize which IP should be blocked in case of the suspension (i.e. incoming requests from that ip will be redirected to walled garden page).
7. Define advanced Suspension Settings under System > Billing > Suspension. You can set up late fees, postpone the suspension of overdue services. Additionally, you can define whether the suspension feature is on/off for all new clients or to turn on/off the suspension globally.
- SERVICE SUSPENDED: email message sent to clients when their service has been suspended.
- POSTPONE SUSPENSION: email message sent to clients when they have postponed their suspension. (Clients are enabled to postpone the suspension by 1 day in order to be able to pay for the service or to reach out with the ISP. This action can be performed only once by the client for a given suspension).
- SUSPENSION RECOGNIZED: message displayed on the walled garden page for suspended clients whose IP address has been recognized. All suspended clients are redirected to this page.
- SUSPENSION ANONYMOUS: message displayed on the walled garden page for suspended clients whose IP was not resolved.