FS::part_export::saisei
Saisei integration for Freeside
This export offers basic svc_broadband provisioning for Saisei.
This is a customer integration with Saisei. This will set up a rate plan and tie the rate plan to a host and the access point via the Saisei API when the broadband service is provisioned. It will also untie the host from the rate plan, setting it to the default rate plan via the API upon unprovisioning of the broadband service.
This will create and modify the rate plans at Saisei as soon as the broadband service attached to this export is created or modified. This will also create and modify an access point at Saisei as soon as the tower is created or modified.
To use this export, follow the below instructions:
Create a new service definition and set the table to svc_broadband. The service name will become the Saisei rate plan name. Set the upload and download speed for the service. This is required to be able to export the service to Saisei. Attach this Saisei export to this service.
Create a tower and add a sector to that tower. The sector name will be the name of the access point, Make sure you have set the up and down rate limit for the tower and the sector. This is required to be able to export the access point. The tower and sector will be set up as access points at Saisei upon the creation of the tower or sector. They will be modified at Saisei when modified in freeside. Each sector will be attached to its tower access point using the Saisei uplink field. Each access point will be attached to the interface set in the export config. If left blank access point will be attached to the default interface. Most setups can leave this blank.
Create a package for the above created service, and order this package for a customer.
Provision the service, making sure to enter the IP address associated with this service and select the tower and sector for it's access point. This provisioned service will then be exported as a host to Saisei.
Unprovisioning this service will set the host entry at Saisei to the default rate plan with the user and access point set to <none>.
After this export is set up and attached to a service, you can export the already provisioned services by clicking the link Export provisioned services attached to this export. Clicking on this link will export all services attached to this export not currently exported to Saisei.
This module also provides generic methods for working through the "Saisei API".
These methods allow access to the Saisei API using the credentials set in the export options.
Accepts $method, $path, $params hashref and optional. Places an api call to the specified path and method with the specified params. Returns the decoded json object returned by the api call. Returns empty on failure; retrieve error messages using "api_error".
Returns the error string set by "Saisei API" methods, or a blank string if most recent call produced no errors.
Gets a list of global policies.
Gets rateplan info for specific rateplan.
Gets user info for specific user.
Gets user info for specific access point.
Gets user info for specific host.
Creates a rateplan.
Modify a new rateplan.
Modify a existing rateplan.
Creates a user.
Modify a user.
Creates a access point.
Modify a new access point.
Modify a existing accesspoint.
ties host to user, rateplan and default access point.
unties host from user and rateplan. this will set the host entry at Saisei to the default rate plan with the user and access point set to <none>.
sets location to lat and long from service, if no service location gets it from package, if still no location returns null.
sets whether the service export requires a sector with it's tower.
required fields needed for tower and sector export.