Configure New Product Using Saisei

These steps will configure a new product in BillMax using Saisei.

1. Define a Resource for Saisei.
   1. Select System Administration > Resources
   2. Name the Resource 'Saisei'.
   3. Assign a new Number.
2. Define one or more Rate Plans.
   1. Select System Administration > Attributes
   2. Click New and enter Name and Description. Example: 25Mb
   3. Enter Type = Saisei and Click Save.
   4. Click Add Attribute.
   5. Enter the Attribute, Operator to '=', and Value.
   6. Repeat steps for more plans or attributes as needed.
   Consult Saisei documentation for supported attributes. Possible attributes include downstream_rate and upstream_rate.
3. Define a Product Definition for a Service or a Package that provides internet access with bandwidth shaping via Saisei™'s STM.
   1. Select Billing Administration > Recurring Service (or Package)
   2. Choose New and enter the required fields, pricing, etc. Set Technology = 'Wireless'.
   3. Click Provisioning Information tab and check 'Saisei' Resource.
   4. Enter the following

      • Field	Value
        Pop Required	Yes
        Access Point Required	Yes
        d01	IP Address
        d02
        d03	Plan Important: On the d03 row set Constraint or Listto 'Saiseigroups' and check Uses List.

   5. Click Save and page will refresh. On the d03 row, set Default to the appropriate plan and Click Save.
4. Create credentials for API use in the Saisei application.
   1. Select System > Adminstrators and click New Administrator.
   2. Enter Name='billmax', Password, and Privilege Level='superuser'. Click Create.
5. Add API credentials to saisei.pl script.
   1. On the BillMax host as the billmax user, edit /usr/local/billmax/local/saisei.pl script.
   2. Locate and set APIPASS and APIHOST.
   3. Make sure the STM firewall allows access from BillMax host on port 5029.
   4. Copy the SERVICE hast entry at the top of the file for use in Step 6 and save the file.
6. Modify and enable the BillMax service hook.
   1. Note: If the service_hook script is not found, copy service_hook-example to service_hook.
      On the BillMax host as the billmax user, edit /usr/local/billmax/local/service_hook script.
   2. Paste the contents (copied from the saisei.pl script) after any existing $SERVICES statements.
   3. Edit the content so that '?' in the pasted data is replaced with the Resource number defined for Saisei and save the file.
7. Test the setup (assumes Saisei STM is fully configured).
   1. Note: Make sure user has name, latitude and longitude values. Otherwise these values will not be passed to Saisei.
      Add service or package with the product definition created in Step 3.
   2. On the new service/package, enter Tower (POP Region), Access Point, IP Address, and Rate Plan. Click Save.
8. Verify results.
   1. If errors show up to the CSR, record error message and provide them to BillMax support.
   2. Check Saisei application to see if it host the specified access point, rate plan, user, and host. If not, send contents of /usr/local/billmax/logs/service_hook.log to BillMax support. Send output of ‘ls -l /usr/local/billmax/local/service_hook’ and ‘ls -l /usr/local/billmax/local/saisei.pl’.