the rate plan to a host and access point via the Saisei API when the broadband service is provisioned.
It will also untie the 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 a access point at Saisei as soon as the tower is created or modified.
+
+To use this export, follow the below instructions:
+
Add a new export and fill out required fields:
-<UL>
-<LI>Hostname or IP - <I>Host name to Saisei API</I></LI>
-<LI>Port - <I>Port number to Saisei API</I></LI>
-<LI>User Name - <I>Saisei API user name</I></LI>
-<LI>Password - <I>Saisei API password</I></LI>
-</UL>
+
+Hostname or IP - <I>Host name to Saisei API
+User Name - <I>Saisei API user name
+Password - <I>Saisei API password
+
Create a broadband service. The broadband service name will become the Saisei rate plan name.
-Set the upload and download speed, and set the modifier to fixed.
-Set IP Address to required.
-Attach Saisei export to service
+Set the upload and download speed for the service. This is required to be able to export the service to Saisei.
+Attach above created Saisei export to this broadband 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 an up and down rate for the Tower and Sector.
+Make sure you have set the up and down rate limit for the Tower and Sector. This is required to be able to export the access point.
-When you provision the service, enter the ip address associated to this service.
-Select the Tower and Sector for it's access point.
+Create a package for the above created broadband service, and order this package for a customer.
-When the service is provisioned it will auto setup the rate plan.
+When you provision the service, enter the ip address associated to 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.
+
+when you un provision this service, the host entry at Saisei will be deleted.
+
+When setting this up, if you wish to export your allready provisioned services, make sure the broadband service has this export attached and
+on export edit screen there will be a link to export Provisioned Services attached to this export. Clicking on that will export all services
+not currently exported to Saisei.
This module also provides generic methods for working through the L</Saisei API>.
=cut
+tie my %scripts, 'Tie::IxHash',
+ 'export_provisioned_services' => { component => '/elements/popup_link.html',
+ label => 'Export provisioned services',
+ description => 'will export provisioned services of part service with Saisei export attached.',
+ html_label => '<b>Export Provisioned Services attached to this export.</b>',
+ },
+;
+
tie my %options, 'Tie::IxHash',
'port' => { label => 'Port',
default => 5000 },
'svc' => 'svc_broadband',
'desc' => 'Export broadband service/account to Saisei',
'options' => \%options,
+ 'scripts' => \%scripts,
'notes' => <<'END',
This is a customer integration with Saisei. This will setup a rate plan and tie
the rate plan to a host and access point via the Saisei API when the broadband service is provisioned.
It will also untie the rate plan via the API upon unprovisioning of the broadband service.
<P>
+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 a access point at Saisei as soon as the tower is created or modified.
+<P>
+To use this export, follow the below instructions:
+<P>
+<OL>
+<LI>
Add a new export and fill out required fields:
<UL>
<LI>Hostname or IP - <I>Host name to Saisei API</I></LI>
<LI>User Name - <I>Saisei API user name</I></LI>
<LI>Password - <I>Saisei API password</I></LI>
</UL>
+</LI>
+<P>
+<LI>
Create a broadband service. The broadband service name will become the Saisei rate plan name.
-Set the upload and download speed, and set the modifier to fixed.
-Set IP Address to required.
-Attach Saisei export to service
+Set the upload and download speed for the service. This is required to be able to export the service to Saisei.
+Attach above created Saisei export to this broadband service.
+</LI>
<P>
+<LI>
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 an up and down rate for the Tower and Sector.
+Make sure you have set the up and down rate limit for the Tower and Sector. This is required to be able to export the access point.
+</LI>
+<P>
+<LI>
+Create a package for the above created broadband service, and order this package for a customer.
+</LI>
+<P>
+<LI>
+When you provision the service, enter the ip address associated to 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.
<P>
-When you provision the service, enter the ip address associated to this service.
-Select the Tower and Sector for it's access point.
+when you un provision this service, the host entry at Saisei will be deleted.
+</LI>
+</OL>
<P>
-When the service is provisioned it will auto setup the rate plan.
+When setting this up, if you wish to export your allready provisioned services, make sure the broadband service has this export attached and
+on export edit screen there will be a link to export Provisioned Services attached to this export. Clicking on that will export all services
+not currently exported to Saisei.
END
);
my $rateplan_name = $service_part->{Hash}->{svc};
$rateplan_name =~ s/\s/_/g;
- # load needed info from our end
- my $cust_main = $svc_broadband->cust_main;
- return "Could not load service customer" unless $cust_main;
- my $conf = new FS::Conf;
-
- # get policy list
- my $policies = $self->api_get_policies();
-
# check for existing rate plan
my $existing_rateplan;
$existing_rateplan = $self->api_get_rateplan($rateplan_name) unless $self->{'__saisei_error'};
# if no existing rate plan create one and modify it.
$self->api_create_rateplan($svc_broadband, $rateplan_name) unless $existing_rateplan;
- $self->api_modify_rateplan($policies->{collection}, $svc_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan);
+ $self->api_modify_rateplan($svc_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan);
+ return $self->api_error if $self->{'__saisei_error'};
# set rateplan to existing one or newly created one.
my $rateplan = $existing_rateplan ? $existing_rateplan : $self->api_get_rateplan($rateplan_name);
if (!$username) {
$self->{'__saisei_error'} = 'no username - can not export';
- warn "No user $username\n" if $self->option('debug');
return $self->api_error;
}
else {
# if no existing user create one.
$self->api_create_user($username, $description) unless $existing_user;
+ return $self->api_error if $self->{'__saisei_error'};
# set user to existing one or newly created one.
my $user = $existing_user ? $existing_user : $self->api_get_user($username);
- ## add access point ?
+ ## add access point
my $tower_sector = FS::Record::qsearchs({
'table' => 'tower_sector',
'select' => 'tower.towername,
- tower.up_rate as toweruprate,
- tower.down_rate as towerdownrate,
+ tower.up_rate_limit as tower_upratelimit,
+ tower.down_rate_limit as tower_downratelimit,
tower_sector.sectorname,
- tower_sector.up_rate as sectoruprate,
- tower_sector.down_rate as sectordownrate ',
+ tower_sector.up_rate_limit as sector_upratelimit,
+ tower_sector.down_rate_limit as sector_downratelimit ',
'addl_from' => 'LEFT JOIN tower USING ( towernum )',
'hashref' => {
'sectornum' => $svc_broadband->{Hash}->{sectornum},
},
});
- my $existing_tower_ap;
my $tower_name = $tower_sector->{Hash}->{towername};
$tower_name =~ s/\s/_/g;
- #check if tower has been set up as an access point.
- $existing_tower_ap = $self->api_get_accesspoint($tower_name) unless $self->{'__saisei_error'};;
+ my $tower_opt = {
+ 'tower_name' => $tower_name,
+ 'tower_uprate_limit' => $tower_sector->{Hash}->{tower_upratelimit},
+ 'tower_downrate_limit' => $tower_sector->{Hash}->{tower_downratelimit},
+ };
- #if tower does not exist as an access point create it.
- $self->api_create_accesspoint(
- $tower_name,
- $tower_sector->{Hash}->{toweruprate},
- $tower_sector->{Hash}->{towerdownrate}
- ) unless $existing_tower_ap;
+ my $tower_ap = process_tower($self, $tower_opt);
+ return $self->api_error if $self->{'__saisei_error'};
- my $existing_sector_ap;
my $sector_name = $tower_sector->{Hash}->{sectorname};
$sector_name =~ s/\s/_/g;
- #check if sector has been set up as an access point.
- $existing_sector_ap = $self->api_get_accesspoint($sector_name);
-
- #if sector does not exist as an access point create it.
- $self->api_create_accesspoint(
- $sector_name,
- $tower_sector->{Hash}->{sectoruprate},
- $tower_sector->{Hash}->{sectordownrate},
- $tower_name,
- ) unless $existing_sector_ap;
-
- # Attach newly created sector to it's tower.
- $self->api_modify_accesspoint($sector_name, $tower_name) unless ($self->{'__saisei_error'} || $existing_sector_ap);
-
- # set access point to existing one or newly created one.
- my $accesspoint = $existing_sector_ap ? $existing_sector_ap : $self->api_get_accesspoint($sector_name);
+ my $sector_opt = {
+ 'tower_name' => $tower_name,
+ 'sector_name' => $sector_name,
+ 'sector_uprate_limit' => $tower_sector->{Hash}->{sector_upratelimit},
+ 'sector_downrate_limit' => $tower_sector->{Hash}->{sector_downratelimit},
+ };
+ my $accesspoint = process_sector($self, $sector_opt);
+ return $self->api_error if $self->{'__saisei_error'};
## tie host to user add sector name as access point.
$self->api_add_host_to_user(
}
sub _export_replace {
- my ($self, $svc_phone) = @_;
+ my ($self, $svc_broadband) = @_;
return '';
}
sub _export_delete {
my ($self, $svc_broadband) = @_;
- my $cust_main = $svc_broadband->cust_main;
- return "Could not load service customer" unless $cust_main;
- my $conf = new FS::Conf;
-
- my $rateplan_name = $svc_broadband->{Hash}->{description};
+ my $service_part = FS::Record::qsearchs( 'part_svc', { 'svcpart' => $svc_broadband->{Hash}->{svcpart} } );
+ my $rateplan_name = $service_part->{Hash}->{svc};
$rateplan_name =~ s/\s/_/g;
-
- my @email = map { $_->emailaddress } FS::Record::qsearch({
- 'table' => 'cust_contact',
- 'select' => 'emailaddress',
- 'addl_from' => ' JOIN contact_email USING (contactnum)',
- 'hashref' => { 'custnum' => $cust_main->{Hash}->{custnum}, },
- });
- my $username = $email[0];
+ my $username = $svc_broadband->{Hash}->{svcnum};
## tie host to user
$self->api_delete_host_to_user($username, $rateplan_name, $svc_broadband->{Hash}->{ip_addr}) unless $self->{'__saisei_error'};
}
sub _export_suspend {
- my ($self, $svc_phone) = @_;
+ my ($self, $svc_broadband) = @_;
return '';
}
sub _export_unsuspend {
- my ($self, $svc_phone) = @_;
+ my ($self, $svc_broadband) = @_;
return '';
}
+sub export_partsvc {
+ my ($self, $svc_part) = @_;
+
+ my $rateplan_name = $svc_part->{Hash}->{svc};
+ $rateplan_name =~ s/\s/_/g;
+ my $speeddown = $svc_part->{Hash}->{svc_broadband__speed_down};
+ my $speedup = $svc_part->{Hash}->{svc_broadband__speed_up};
+
+ my $temp_svc = $svc_part->{Hash};
+ my $svc_broadband = {};
+ map { if ($_ =~ /^svc_broadband__(.*)$/) { $svc_broadband->{Hash}->{$1} = $temp_svc->{$_}; } } keys %$temp_svc;
+
+ # check for existing rate plan
+ my $existing_rateplan;
+ $existing_rateplan = $self->api_get_rateplan($rateplan_name) unless $self->{'__saisei_error'};
+
+ # Modify the existing rate plan with new service data.
+ $self->api_modify_existing_rateplan($svc_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || !$existing_rateplan);
+
+ # if no existing rate plan create one and modify it.
+ $self->api_create_rateplan($svc_broadband, $rateplan_name) unless $existing_rateplan;
+ $self->api_modify_rateplan($svc_part, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan);
+
+ return $self->api_error;
+
+}
+
+sub export_tower_sector {
+ my ($self, $tower) = @_;
+
+ #modify tower or create it.
+ my $tower_name = $tower->{Hash}->{towername};
+ $tower_name =~ s/\s/_/g;
+ my $tower_opt = {
+ 'tower_name' => $tower_name,
+ 'tower_uprate_limit' => $tower->{Hash}->{up_rate_limit},
+ 'tower_downrate_limit' => $tower->{Hash}->{down_rate_limit},
+ 'modify_existing' => '1', # modify an existing access point with this info
+ };
+
+ my $tower_access_point = process_tower($self, $tower_opt);
+
+ #get list of all access points
+ my $hash_opt = {
+ 'table' => 'tower_sector',
+ 'select' => '*',
+ 'hashref' => { 'towernum' => $tower->{Hash}->{towernum}, },
+ };
+
+ #for each one modify or create it.
+ foreach my $tower_sector ( FS::Record::qsearch($hash_opt) ) {
+ my $sector_name = $tower_sector->{Hash}->{sectorname};
+ $sector_name =~ s/\s/_/g;
+ my $sector_opt = {
+ 'tower_name' => $tower_name,
+ 'sector_name' => $sector_name,
+ 'sector_uprate_limit' => $tower_sector->{Hash}->{up_rate_limit},
+ 'sector_downrate_limit' => $tower_sector->{Hash}->{down_rate_limit},
+ 'modify_existing' => '1', # modify an existing access point with this info
+ };
+ my $sector_access_point = process_sector($self, $sector_opt);
+ }
+
+ return $self->api_error;
+}
+
=head1 Saisei API
These methods allow access to the Saisei API using the credentials
sub api_call {
my ($self,$method,$path,$params) = @_;
+
$self->{'__saisei_error'} = '';
my $auth_info = $self->option('username') . ':' . $self->option('password');
$params ||= {};
}
}
else {
- $self->{'__saisei_error'} = "Bad response from server during $method: " . $client->responseContent();
+ $self->{'__saisei_error'} = "Bad response from server during $method: " . $client->responseContent()
+ unless ($method eq "GET");
warn "Response Content is\n".$client->responseContent."\n" if $self->option('debug');
return;
}
$self->{'__saisei_error'} = "Did not receive any global policies"
unless $get_policies;
- return $get_policies;
+ return $get_policies->{collection};
}
=head2 api_get_rateplan
my $get_rateplan = $self->api_call("GET", "/rate_plans/$rateplan");
return if $self->api_error;
- $self->{'__saisei_error'} = "Did not receive any rateplan info"
- unless $get_rateplan;
return $get_rateplan;
}
my $get_user = $self->api_call("GET", "/users/$user");
return if $self->api_error;
- $self->{'__saisei_error'} = "Did not receive any user info"
- unless $get_user;
return $get_user;
}
my $get_accesspoint = $self->api_call("GET", "/access_points/$accesspoint");
return if $self->api_error;
- $self->{'__saisei_error'} = "Did not receive any access point info"
- unless $get_accesspoint;
return $get_accesspoint;
}
+=head2 api_get_host
+
+Gets user info for specific host.
+
+=cut
+
+sub api_get_host {
+ my $self = shift;
+ my $ip = shift;
+
+ my $get_host = $self->api_call("GET", "/hosts/$ip");
+
+ return if $self->api_error;
+
+ return $get_host;
+}
+
=head2 api_create_rateplan
Creates a rateplan.
sub api_create_rateplan {
my ($self, $svc, $rateplan) = @_;
+ $self->{'__saisei_error'} = "No downrate listed for service $rateplan" if !$svc->{Hash}->{speed_down};
+ $self->{'__saisei_error'} = "No uprate listed for service $rateplan" if !$svc->{Hash}->{speed_up};
+
my $new_rateplan = $self->api_call(
"PUT",
"/rate_plans/$rateplan",
'downstream_rate' => $svc->{Hash}->{speed_down},
'upstream_rate' => $svc->{Hash}->{speed_up},
},
- );
+ ) unless $self->{'__saisei_error'};
$self->{'__saisei_error'} = "Rate Plan not created"
- unless $new_rateplan; # should never happen
+ unless ($new_rateplan || $self->{'__saisei_error'});
+
return $new_rateplan;
}
=head2 api_modify_rateplan
-Modify a rateplan.
+Modify a new rateplan.
=cut
sub api_modify_rateplan {
- my ($self,$policies,$svc,$rateplan_name) = @_;
+ my ($self,$svc,$rateplan_name) = @_;
+
+ # get policy list
+ my $policies = $self->api_get_policies();
foreach my $policy (@$policies) {
my $policyname = $policy->{name};
},
);
- $self->{'__saisei_error'} = "Rate Plan not modified"
- unless $modified_rateplan; # should never happen
+ $self->{'__saisei_error'} = "Rate Plan not modified after create"
+ unless ($modified_rateplan || $self->{'__saisei_error'}); # should never happen
}
}
+=head2 api_modify_existing_rateplan
+
+Modify a existing rateplan.
+
+=cut
+
+sub api_modify_existing_rateplan {
+ my ($self,$svc,$rateplan_name) = @_;
+
+ my $modified_rateplan = $self->api_call(
+ "PUT",
+ "/rate_plans/$rateplan_name",
+ {
+ 'downstream_rate' => $svc->{Hash}->{speed_down},
+ 'upstream_rate' => $svc->{Hash}->{speed_up},
+ },
+ );
+
+ $self->{'__saisei_error'} = "Rate Plan not modified"
+ unless ($modified_rateplan || $self->{'__saisei_error'}); # should never happen
+
+ return;
+
+}
+
=head2 api_create_user
Creates a user.
);
$self->{'__saisei_error'} = "User not created"
- unless $new_user; # should never happen
+ unless ($new_user || $self->{'__saisei_error'}); # should never happen
return $new_user;
=cut
sub api_create_accesspoint {
- my ($self,$accesspoint, $uprate, $downrate) = @_;
+ my ($self,$accesspoint, $upratelimit, $downratelimit) = @_;
# this has not been tested, but should work, if needed.
my $new_accesspoint = $self->api_call(
"PUT",
"/access_points/$accesspoint",
{
- 'downstream_rate_limit' => $downrate,
- 'upstream_rate_limit' => $uprate,
+ 'downstream_rate_limit' => $downratelimit,
+ 'upstream_rate_limit' => $upratelimit,
},
);
$self->{'__saisei_error'} = "Access point not created"
- unless $new_accesspoint; # should never happen
+ unless ($new_accesspoint || $self->{'__saisei_error'}); # should never happen
return;
}
=head2 api_modify_accesspoint
-Modify a access point.
+Modify a new access point.
=cut
sub api_modify_accesspoint {
my ($self, $accesspoint, $uplink) = @_;
- my $modified_rateplan = $self->api_call(
+ my $modified_accesspoint = $self->api_call(
"PUT",
"/access_points/$accesspoint",
{
);
$self->{'__saisei_error'} = "Rate Plan not modified"
- unless $modified_rateplan; # should never happen
+ unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
+
+ return;
+
+}
+
+=head2 api_modify_existing_accesspoint
+
+Modify a existing accesspoint.
+
+=cut
+
+sub api_modify_existing_accesspoint {
+ my ($self, $accesspoint, $uplink, $upratelimit, $downratelimit) = @_;
+
+ my $modified_accesspoint = $self->api_call(
+ "PUT",
+ "/access_points/$accesspoint",
+ {
+ 'downstream_rate_limit' => $downratelimit,
+ 'upstream_rate_limit' => $upratelimit,
+# 'uplink' => $uplink, # name of attached access point
+ },
+ );
+
+ $self->{'__saisei_error'} = "Access point not modified"
+ unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
return;
);
$self->{'__saisei_error'} = "Host not created"
- unless $new_host; # should never happen
+ unless ($new_host || $self->{'__saisei_error'}); # should never happen
return $new_host;
);
$self->{'__saisei_error'} = "Host not created"
- unless $delete_host; # should never happen
+ unless ($delete_host || $self->{'__saisei_error'}); # should never happen
return $delete_host;
}
+sub process_tower {
+ my ($self, $opt) = @_;
+
+ my $existing_tower_ap;
+ my $tower_name = $opt->{tower_name};
+
+ #check if tower has been set up as an access point.
+ $existing_tower_ap = $self->api_get_accesspoint($tower_name) unless $self->{'__saisei_error'};
+
+ # modify the existing accesspoint if changing tower .
+ $self->api_modify_existing_accesspoint (
+ $tower_name,
+ '', # tower does not have a uplink on sectors.
+ $opt->{tower_uprate_limit},
+ $opt->{tower_downrate_limit},
+ ) if $existing_tower_ap && $opt->{modify_existing};
+
+ #if tower does not exist as an access point create it.
+ $self->api_create_accesspoint(
+ $tower_name,
+ $opt->{tower_uprate_limit},
+ $opt->{tower_downrate_limit}
+ ) unless $existing_tower_ap;
+
+ my $accesspoint = $self->api_get_accesspoint($tower_name);
+
+ return $accesspoint;
+}
+
+sub process_sector {
+ my ($self, $opt) = @_;
+
+ my $existing_sector_ap;
+ my $sector_name = $opt->{sector_name};
+
+ #check if sector has been set up as an access point.
+ $existing_sector_ap = $self->api_get_accesspoint($sector_name);
+
+ # modify the existing accesspoint if changing sector .
+ $self->api_modify_existing_accesspoint (
+ $sector_name,
+ $opt->{tower_name},
+ $opt->{sector_uprate_limit},
+ $opt->{sector_downrate_limit},
+ ) if $existing_sector_ap && $opt->{modify_existing};
+
+ #if sector does not exist as an access point create it.
+ $self->api_create_accesspoint(
+ $sector_name,
+ $opt->{sector_uprate_limit},
+ $opt->{sector_downrate_limit},
+ ) unless $existing_sector_ap;
+
+ # Attach newly created sector to it's tower.
+ $self->api_modify_accesspoint($sector_name, $opt->{tower_name}) unless ($self->{'__saisei_error'} || $existing_sector_ap);
+
+ # set access point to existing one or newly created one.
+ my $accesspoint = $existing_sector_ap ? $existing_sector_ap : $self->api_get_accesspoint($sector_name);
+
+ return $accesspoint;
+}
+
+sub export_provisioned_services {
+ my $job = shift;
+ my $param = shift;
+
+ my $part_export = FS::Record::qsearchs('part_export', { 'exportnum' => $param->{export_provisioned_services_exportnum}, } )
+ or die "unknown exportnum $param->{export_provisioned_services_exportnum}";
+ bless $part_export;
+
+ my @svcparts = FS::Record::qsearch({
+ 'table' => 'export_svc',
+ 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart ) ',
+ 'hashref' => { 'exportnum' => $param->{export_provisioned_services_exportnum}, },
+ });
+ my $part_count = scalar @svcparts;
+
+ my $parts = join "', '", map { $_->{Hash}->{svcpart} } @svcparts;
+
+ my @svcs = FS::Record::qsearch({
+ 'table' => 'cust_svc',
+ 'addl_from' => 'LEFT JOIN svc_broadband USING ( svcnum ) ',
+ 'extra_sql' => " WHERE svcpart in ('".$parts."')",
+ });
+
+ my $svc_count = scalar @svcs;
+
+ my %status = {};
+ for (my $c=10; $c <=100; $c=$c+10) { $status{int($svc_count * ($c/100))} = $c; }
+
+ my $process_count=0;
+ foreach my $svc (@svcs) {
+ if ($status{$process_count}) { my $s = $status{$process_count}; $job->update_statustext($s); }
+ ## check if service exists as host if not export it.
+ _export_insert($part_export,$svc) unless api_get_host($part_export, $svc->{Hash}->{ip_addr});
+ $process_count++;
+ }
+
+ return;
+
+}
+
=head1 SEE ALSO
L<FS::part_export>
projects / freeside.git / blobdiff