From: Christopher Burger Date: Tue, 13 Mar 2018 18:07:39 +0000 (-0400) Subject: RT# 78356 - updated documentation and added ability to create access points as Saisei... X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=commitdiff_plain;h=d81d88c7ec4a69aaf14a9da961e16c8af630fd68 RT# 78356 - updated documentation and added ability to create access points as Saisei thru api Conflicts: FS/FS/Schema.pm FS/FS/part_export/saisei.pm FS/FS/tower_sector.pm httemplate/edit/process/tower.html httemplate/edit/tower.html httemplate/elements/tr-tower_sectors.html --- diff --git a/FS/FS/Schema.pm b/FS/FS/Schema.pm index d0322545c..8e28980ec 100644 --- a/FS/FS/Schema.pm +++ b/FS/FS/Schema.pm @@ -3342,6 +3342,8 @@ sub tables_hashref { 'height', 'decimal', 'NULL', '', '', '', 'veg_height', 'decimal', 'NULL', '', '', '', 'color', 'varchar', 'NULL', 6, '', '', + 'up_rate', 'int', 'NULL', '', '', '', + 'down_rate', 'int', 'NULL', '', '', '', ], 'primary_key' => 'towernum', 'unique' => [ [ 'towername' ] ], # , 'agentnum' ] ], @@ -3367,6 +3369,9 @@ sub tables_hashref { 'east', 'decimal', 'NULL', '10,7', '', '', 'south', 'decimal', 'NULL', '10,7', '', '', 'north', 'decimal', 'NULL', '10,7', '', '', + 'title', 'varchar', 'NULL', $char_d,'', '', + 'up_rate', 'int', 'NULL', '', '', '', + 'down_rate', 'int', 'NULL', '', '', '', ], 'primary_key' => 'sectornum', 'unique' => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ], diff --git a/FS/FS/part_export/saisei.pm b/FS/FS/part_export/saisei.pm index c7ee6f638..88baaada6 100644 --- a/FS/FS/part_export/saisei.pm +++ b/FS/FS/part_export/saisei.pm @@ -24,18 +24,29 @@ Saisei integration for Freeside This export offers basic svc_broadband provisioning for Saisei. -This is a customer integration with Saisei. This will setup a rate plan and tie -the rate plan to a host 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 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. -This export will use the broadband service descriptive label for the Saisei rate plan name and -will use the email from the first contact for the Saisei username that will be -attached to this rate plan. It will use the Saisei default Access Point. +Add a new export and fill out required fields: + +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 + +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. + +When you provision the service, enter the ip address associated to this service. +Select the Tower and Sector for it's access point. -Hostname or IP - Host name to Saisei API -Port - Port number to Saisei API -User Name - Saisei API user name -Password - Saisei API password +When the service is provisioned it will auto setup the rate plan. This module also provides generic methods for working through the L. @@ -58,27 +69,37 @@ tie my %options, 'Tie::IxHash', 'options' => \%options, 'notes' => <<'END', This is a customer integration with Saisei. This will setup a rate plan and tie -the rate plan to a host 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 export will use the broadband service descriptive label for the Saisei rate plan name and -will use the email from the first contact for the Saisei username that will be -attached to this rate plan. It will use the Saisei default Access Point. +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.

-Required Fields: +Add a new export and fill out required fields:

  • Hostname or IP - Host name to Saisei API
  • Port - Port number to Saisei API
  • User Name - Saisei API user name
  • Password - 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 +

+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. +

+When you provision the service, enter the ip address associated to this service. +Select the Tower and Sector for it's access point. +

+When the service is provisioned it will auto setup the rate plan. END ); sub _export_insert { my ($self, $svc_broadband) = @_; - my $rateplan_name = $svc_broadband->{Hash}->{description}; - $rateplan_name =~ s/\s/_/g; + 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; # load needed info from our end my $cust_main = $svc_broadband->cust_main; @@ -99,19 +120,13 @@ sub _export_insert { # set rateplan to existing one or newly created one. my $rateplan = $existing_rateplan ? $existing_rateplan : $self->api_get_rateplan($rateplan_name); - my @email = map { $_->emailaddress } FS::Record::qsearch({ - 'table' => 'contact', - 'select' => 'emailaddress', - 'addl_from' => ' JOIN contact_email USING (contactnum)', - 'hashref' => { 'custnum' => $cust_main->{Hash}->{custnum}, }, - }); - my $username = $email[0]; - my $description = $cust_main->{Hash}->{first}." ".$cust_main->{Hash}->{last}; + my $username = $svc_broadband->{Hash}->{svcnum}; + my $description = $svc_broadband->{Hash}->{description}; if (!$username) { $self->{'__saisei_error'} = 'no username - can not export'; - warn "No email found $username\n" if $self->option('debug'); - return; + warn "No user $username\n" if $self->option('debug'); + return $self->api_error; } else { # check for existing user. @@ -125,12 +140,65 @@ sub _export_insert { my $user = $existing_user ? $existing_user : $self->api_get_user($username); ## add access point ? - - ## tie host to user - $self->api_add_host_to_user($user->{collection}->[0]->{name}, $rateplan->{collection}->[0]->{name}, $svc_broadband->{Hash}->{ip_addr}) unless $self->{'__saisei_error'}; + my $tower_sector = FS::Record::qsearchs({ + 'table' => 'tower_sector', + 'select' => 'tower.towername, + tower.up_rate as toweruprate, + tower.down_rate as towerdownrate, + tower_sector.sectorname, + tower_sector.up_rate as sectoruprate, + tower_sector.down_rate as sectordownrate ', + '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'};; + + #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 $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); + + ## tie host to user add sector name as access point. + $self->api_add_host_to_user( + $user->{collection}->[0]->{name}, + $rateplan->{collection}->[0]->{name}, + $svc_broadband->{Hash}->{ip_addr}, + $accesspoint->{collection}->[0]->{name}, + ) unless $self->{'__saisei_error'}; } - return ''; + return $self->api_error; } @@ -229,7 +297,7 @@ sub api_call { =head2 api_error -Returns the error string set by L methods, +Returns the error string set by L methods, or a blank string if most recent call produced no errors. =cut @@ -300,14 +368,14 @@ Gets user info for specific access point. sub api_get_accesspoint { my $self = shift; - my $accesspoint; + my $accesspoint = shift; my $get_accesspoint = $self->api_call("GET", "/access_points/$accesspoint"); return if $self->api_error; - $self->{'__saisei_error'} = "Did not receive any user info" + $self->{'__saisei_error'} = "Did not receive any access point info" unless $get_accesspoint; - return; + return $get_accesspoint; } =head2 api_create_rateplan @@ -397,19 +465,44 @@ Creates a access point. =cut sub api_create_accesspoint { - my ($self,$accesspoint) = @_; + my ($self,$accesspoint, $uprate, $downrate) = @_; # this has not been tested, but should work, if needed. - #my $new_accesspoint = $self->api_call( - # "PUT", - # "/access_points/$accesspoint", - # { - # 'description' => 'my description', - # }, - #); - - #$self->{'__saisei_error'} = "Access point not created" - # unless $new_accesspoint; # should never happen + my $new_accesspoint = $self->api_call( + "PUT", + "/access_points/$accesspoint", + { + 'downstream_rate_limit' => $downrate, + 'upstream_rate_limit' => $uprate, + }, + ); + + $self->{'__saisei_error'} = "Access point not created" + unless $new_accesspoint; # should never happen + return; + +} + +=head2 api_modify_accesspoint + +Modify a access point. + +=cut + +sub api_modify_accesspoint { + my ($self, $accesspoint, $uplink) = @_; + + my $modified_rateplan = $self->api_call( + "PUT", + "/access_points/$accesspoint", + { + 'uplink' => $uplink, # name of attached access point + }, + ); + + $self->{'__saisei_error'} = "Rate Plan not modified" + unless $modified_rateplan; # should never happen + return; } @@ -421,7 +514,7 @@ ties host to user, rateplan and default access point. =cut sub api_add_host_to_user { - my ($self,$user, $rateplan, $ip) = @_; + my ($self,$user, $rateplan, $ip, $accesspoint) = @_; my $new_host = $self->api_call( "PUT", @@ -429,6 +522,7 @@ sub api_add_host_to_user { { 'user' => $user, 'rate_plan' => $rateplan, + 'access_point' => $accesspoint, }, ); diff --git a/FS/FS/tower.pm b/FS/FS/tower.pm index 5497c7217..b02e2ab87 100644 --- a/FS/FS/tower.pm +++ b/FS/FS/tower.pm @@ -44,6 +44,14 @@ Tower name Disabled flag, empty or 'Y' +=item up_rate + +Up Rate for towner + +=item down_rate + +Down Rate for tower + =back =head1 METHODS @@ -97,6 +105,8 @@ sub check { || $self->ut_floatn('height') || $self->ut_floatn('veg_height') || $self->ut_alphan('color') + || $self->ut_numbern('up_rate') + || $self->ut_numbern('down_rate') ; return $error if $error; diff --git a/FS/FS/tower_sector.pm b/FS/FS/tower_sector.pm index 6ccfe553d..524fceca1 100644 --- a/FS/FS/tower_sector.pm +++ b/FS/FS/tower_sector.pm @@ -93,6 +93,18 @@ The coverage map, as a PNG. The coordinate boundaries of the coverage map. +=item title + +The sector title. + +=item up_rate + +Up rate for sector. + +=item down_rate + +down rate for sector. + =back =head1 METHODS @@ -155,6 +167,8 @@ sub check { || $self->ut_numbern('downtilt') || $self->ut_floatn('sector_range') || $self->ut_numbern('margin') + || $self->ut_numbern('up_rate') + || $self->ut_numbern('down_rate') || $self->ut_anything('image') || $self->ut_sfloatn('west') || $self->ut_sfloatn('east') diff --git a/httemplate/edit/process/tower.html b/httemplate/edit/process/tower.html index d14ac56f8..e17cd55ae 100644 --- a/httemplate/edit/process/tower.html +++ b/httemplate/edit/process/tower.html @@ -5,7 +5,7 @@ 'fields' => [qw( sectorname ip_addr height freq_mhz direction width downtilt v_width margin - sector_range + sector_range up_rate down_rate )], }, &> diff --git a/httemplate/edit/tower.html b/httemplate/edit/tower.html index 377a33e9b..660788849 100644 --- a/httemplate/edit/tower.html +++ b/httemplate/edit/tower.html @@ -12,6 +12,8 @@ 'altitude', 'height', 'veg_height', + 'up_rate', + 'down_rate', { field => 'sectornum', type => 'tower_sector', o2m_table => 'tower_sector', @@ -30,6 +32,8 @@ 'height' => 'Height (feet)', 'veg_height' => 'Vegetation height (feet)', 'color' => 'Color', + 'up_rate' => 'Up Rate (Kbps)', + 'down_rate' => 'Down Rate (Kbps)', }, &> <%init> @@ -38,7 +42,8 @@ my $m2_error_callback = sub { # reconstruct the list my ($cgi, $object) = @_; my @fields = qw( - sectorname ip_addr height freq_mhz direction width tilt v_width margin sector_range + sectorname ip_addr height freq_mhz direction width tilt v_width margin + sector_range up_rate down_rate ); map { diff --git a/httemplate/elements/tr-tower_sectors.html b/httemplate/elements/tr-tower_sectors.html new file mode 100644 index 000000000..6843f4fdc --- /dev/null +++ b/httemplate/elements/tr-tower_sectors.html @@ -0,0 +1,310 @@ +<%shared> +# kind of a hack... +my ($export) = FS::tower_sector->part_export; +my $antenna_types; # will be an ordered hash +if ($export and $export->can('get_antenna_types')) { + $antenna_types = $export->get_antenna_types; +} + +<%init> +my %opt = @_; +my $tower = $opt{'object'}; +my $towernum = $tower->towernum; +my $cgi = $opt{'cgi'}; + +my $tabcounter = 0; + +my @fields = qw( + sectorname ip_addr height freq_mhz direction width downtilt v_width + db_high db_low sector_range + power line_loss antenna_gain hardware_typenum up_rate down_rate +); + +my @sectors; +if ( $cgi->param('error') ) { + foreach my $k ($cgi->param) { + if ($k =~ /^sectornum\d+$/) { + my $sectornum = $cgi->param($k); + my $sector = FS::tower_sector->new({ + 'sectornum' => $sectornum, + 'towernum' => $towernum, + map { $_ => scalar($cgi->param($k.'_'.$_)) } @fields, + }); + push @sectors, $sector if length($sector->sectorname); + } + } +} elsif ( $towernum ) { + @sectors = $tower->tower_sector; +} # else new mode, no sectors yet + +my $id = $opt{id} || $opt{field} || 'sectornum'; + + +<& tablebreak-tr-title.html, value => 'Sectors' &> + + + + + + +%# prototypes +

+<& .tab, id => $id . '_P' &> +<& .panel, id => $id . '_P' &> +
+ +%# main container +
+
    +% foreach my $sector (@sectors) { +<& .tab, sector => $sector, id => $id . $tabcounter &> +% $tabcounter++; +% } +
+ +% $tabcounter = 0; +% foreach my $sector (@sectors) { +<& .panel, sector => $sector, id => $id . $tabcounter &> +% $tabcounter++; +% } +
+ + + +<%def .tab> +% my %opt = @_; +% my $sector = $opt{sector}; +% my $id = $opt{id}; +% my $title = $sector ? $sector->sectorname : mt('Add new'); +
  • + <% $title |h %> +
    • + +<%def .panel> +% my %opt = @_; +% my $sector = $opt{sector} || FS::tower_sector->new({}); +% my $id = $opt{id}; # sectornumX +
    +% # no id on this one, the panel gets the "sectornumX" id + +

    + + + + + +

    +

    + + + <% emt('feet above ground') %> +

    +

    + + ° + + ° +

    + +

    + + + <% emt('MHz') %> +

    + +

    + + + <% emt('dBm') %>
    + + + <% emt('dB antenna gain') %>
    + + + <% emt('dB line loss') %> + +% if ( $antenna_types ) { +

    + + <& /elements/select.html, + field => $id.'_hardware_typenum', + options => [ '', keys %$antenna_types ], + labels => $antenna_types, + curr_value => $sector->hardware_typenum, + &> +

    +% } +% # this next section might not be necessary if you enter an antenna type +

    + + ° + + ° +

    + + +
    + + <% emt('dB (high quality)') %> +
    + + + <% emt('dB (low quality)') %> +
    +

    + + +

    +

    + + +

    + +
    +