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.
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>',
+ error_url => '/edit/part_export.cgi?',
+ success_message => 'Saisei export of provisioned services successful',
+ },
+ 'export_all_towers_sectors' => { component => '/elements/popup_link.html',
+ label => 'Export of all towers and sectors',
+ description => 'Will force an export of all towers and sectors to Saisei as access points.',
+ html_label => '<b>Export all towers and sectors.</b>',
+ error_url => '/edit/part_export.cgi?',
+ success_message => 'Saisei export of towers and sectors as access points successful',
+ },
+ 'force_export_all_users' => { component => '/elements/popup_link.html',
+ label => 'Force update of all Saisei users from freeside provisioned services',
+ description => 'Will force an update of Saisei users description and map location from freeside provisioned services.',
+ html_label => '<b>Force update of all Saisei users from freeside provisioned services</b>',
+ error_url => '/edit/part_export.cgi?',
+ success_message => 'Export of freeside provisioned services as Saisei users was successful',
+ },
+ 'force_export_all_virtual_ap' => { component => '/elements/popup_link.html',
+ label => 'Force update of all virtual Access Points',
+ description => 'Will force an update of all virtual access points.',
+ html_label => '<b>Force update of all virtual Access Points</b>',
+ error_url => '/edit/part_export.cgi?',
+ success_message => 'Export of all virtual access points to Saisei was successful',
},
;
default => '' },
'password' => { label => 'Saisei API Password',
default => '' },
+ 'interface' => { label => 'Saisei Access Point Interface',
+ default => '' },
'debug' => { type => 'checkbox',
label => 'Enable debug warnings' },
;
<OL>
<LI>
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.
+Set the upload speed, download speed, and tower to be required for the service. This is required to be able to export the service to Saisei.
Attach this Saisei export to this service.
</LI>
<P>
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.
</LI>
<P>
<LI>
</LI>
<P>
<LI>
-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.
+Provision the service, making sure to enter the IP address associated with this service, the upload and download speed are correct, and select the tower and sector for it's access point.
This provisioned service will then be exported as a host to Saisei.
<P>
Unprovisioning this service will set the host entry at Saisei to the default rate plan with the user and access point set to <i>none</i>.
</LI>
</OL>
<P>
-
+<A HREF="http://www.freeside.biz/mediawiki/index.php/Saisei_provisioning_export" target="_new">Documentation</a>
END
);
sub _export_insert {
- my ($self, $svc_broadband) = @_;
+ my ($self, $svc_broadband, $force_update) = @_;
my $rateplan_name = $self->get_rateplan_name($svc_broadband);
my $existing_rateplan;
$existing_rateplan = $self->api_get_rateplan($rateplan_name) unless $self->{'__saisei_error'};
+ die ("Please double check your credentials as ".$existing_rateplan->{message}."\n") if $existing_rateplan->{message};
+
# 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_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan);
+ $self->api_create_rateplan($svc_broadband, $rateplan_name) unless $existing_rateplan->{collection};
+ $self->api_modify_rateplan($svc_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan->{collection});
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);
+ my $rateplan = $existing_rateplan->{collection} ? $existing_rateplan : $self->api_get_rateplan($rateplan_name);
my $username = $svc_broadband->{Hash}->{svcnum};
my $description = $svc_broadband->{Hash}->{description};
+ my $svc_location = get_svc_location($self, $svc_broadband);
if (!$username) {
$self->{'__saisei_error'} = 'no username - can not export';
$existing_user = $self->api_get_user($username) unless $self->{'__saisei_error'};
# if no existing user create one.
- $self->api_create_user($username, $description) unless $existing_user;
+ $self->api_create_user($username, $description, $svc_location) unless $existing_user;
return $self->api_error if $self->{'__saisei_error'};
# set user to existing one or newly created one.
tower.up_rate_limit as tower_upratelimit,
tower.down_rate_limit as tower_downratelimit,
tower_sector.sectorname,
+ tower_sector.towernum,
tower_sector.up_rate_limit as sector_upratelimit,
- tower_sector.down_rate_limit as sector_downratelimit ',
+ tower_sector.down_rate_limit as sector_downratelimit,
+ tower.latitude,
+ tower.longitude',
'addl_from' => 'LEFT JOIN tower USING ( towernum )',
'hashref' => {
'sectornum' => $svc_broadband->{Hash}->{sectornum},
},
});
+ my $tower_location;
+ $tower_location = $tower_sector->{Hash}->{latitude}.','.$tower_sector->{Hash}->{longitude} if ($tower_sector->{Hash}->{latitude} && $tower_sector->{Hash}->{longitude});
+
my $tower_name = $tower_sector->{Hash}->{towername};
$tower_name =~ s/\s/_/g;
my $tower_opt = {
'tower_name' => $tower_name,
+ 'tower_num' => $tower_sector->{Hash}->{towernum},
'tower_uprate_limit' => $tower_sector->{Hash}->{tower_upratelimit},
'tower_downrate_limit' => $tower_sector->{Hash}->{tower_downratelimit},
};
+ $tower_opt->{'location'} = $tower_location if $tower_location;
my $tower_ap = process_tower($self, $tower_opt);
return $self->api_error if $self->{'__saisei_error'};
my $sector_opt = {
'tower_name' => $tower_name,
+ 'tower_num' => $tower_sector->{Hash}->{towernum},
'sector_name' => $sector_name,
'sector_uprate_limit' => $tower_sector->{Hash}->{sector_upratelimit},
'sector_downrate_limit' => $tower_sector->{Hash}->{sector_downratelimit},
+ 'rateplan' => $rateplan_name,
};
+ $sector_opt->{'location'} = $tower_location if $tower_location;
+
my $accesspoint = process_sector($self, $sector_opt);
return $self->api_error if $self->{'__saisei_error'};
'table' => 'cust_pkg',
'hashref' => { 'pkgnum' => $svc_broadband->{Hash}->{pkgnum}, },
});
+
my $virtual_ap_name = $cust_pkg->{Hash}->{custnum}.'_'.$cust_pkg->{Hash}->{pkgpart}.'_'.$svc_broadband->{Hash}->{speed_down}.'_'.$svc_broadband->{Hash}->{speed_up};
+ my $modify_existing_virtual_ap = '1' if $force_update->{'update_virtual_ap'};
my $virtual_ap_opt = {
'virtual_name' => $virtual_ap_name,
'sector_name' => $sector_name,
'virtual_uprate_limit' => $svc_broadband->{Hash}->{speed_up},
'virtual_downrate_limit' => $svc_broadband->{Hash}->{speed_down},
+ 'location' => $svc_location,
+ 'modify_existing' => $modify_existing_virtual_ap,
};
my $virtual_ap = process_virtual_ap($self, $virtual_ap_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(
- $user->{collection}->[0]->{name},
- $rateplan->{collection}->[0]->{name},
- $svc_broadband->{Hash}->{ip_addr},
- $virtual_ap->{collection}->[0]->{name},
- ) unless $self->{'__saisei_error'};
+ my $host_opt = {
+ 'user' => $user->{collection}->[0]->{name},
+ 'rateplan' => $rateplan->{collection}->[0]->{name},
+ 'ip' => $svc_broadband->{Hash}->{ip_addr},
+ 'accesspoint' => $virtual_ap->{collection}->[0]->{name},
+ 'location' => $svc_location,
+ };
+ $self->api_add_host_to_user($host_opt)
+ unless $self->{'__saisei_error'};
}
return $self->api_error;
return;
}
+ my $tower_location;
+ $tower_location = $tower->{Hash}->{latitude}.','.$tower->{Hash}->{longitude} if ($tower->{Hash}->{latitude} && $tower->{Hash}->{longitude});
+
#modify tower or create it.
my $tower_name = $tower->{Hash}->{towername};
$tower_name =~ s/\s/_/g;
my $tower_opt = {
'tower_name' => $tower_name,
+ 'tower_num' => $tower->{Hash}->{towernum},
'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
};
+ $tower_opt->{'location'} = $tower_location if $tower_location;
my $tower_access_point = process_tower($self, $tower_opt);
return $tower_access_point if $tower_access_point->{error};
#for each one modify or create it.
foreach my $tower_sector ( FS::Record::qsearch($hash_opt) ) {
+ next if $tower_sector->{Hash}->{sectorname} eq "_default";
my $sector_name = $tower_sector->{Hash}->{sectorname};
$sector_name =~ s/\s/_/g;
my $sector_opt = {
'tower_name' => $tower_name,
+ 'tower_num' => $tower_sector->{Hash}->{towernum},
'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
};
+ $sector_opt->{'location'} = $tower_location if $tower_location;
+
my $sector_access_point = process_sector($self, $sector_opt) unless ($sector_name eq "_default");
return $sector_access_point if $sector_access_point->{error};
}
return { error => $self->api_error, };
}
+sub export_user {
+ my ($self, $username, $description, $location) = @_;
+
+ $self->api_create_user($username, $description, $location);
+
+ return $self->api_error if $self->{'__saisei_error'};
+
+ return '';
+}
+
## creates the rateplan name
sub get_rateplan_name {
my ($self, $svc_broadband, $svc_name) = @_;
my $service_name = $svc_name ? $svc_name : $service_part->{Hash}->{svc};
my $rateplan_name = $service_name . " " . $svc_broadband->{Hash}->{speed_down} . "-" . $svc_broadband->{Hash}->{speed_up};
- $rateplan_name =~ s/\s/_/g;
+ $rateplan_name =~ s/\s/_/g; $rateplan_name =~ s/[^A-Za-z0-9\-_]//g;
return $rateplan_name;
}
$client->setHost('http://'.$self->{Hash}->{machine}.':'.$self->option('port'));
$client->$method('/rest/top/configurations/running'.$path, $data, { "Content-type" => 'application/json'});
- warn "Response Code is ".$client->responseCode()."\n" if $self->option('debug');
+ warn "Saisei Response Code is ".$client->responseCode()."\n" if $self->option('debug');
my $result;
if ($client->responseCode() eq '200' || $client->responseCode() eq '201') {
eval { $result = decode_json($client->responseContent()) };
unless ($result) {
- $self->{'__saisei_error'} = "Error decoding json: $@";
+ $self->{'__saisei_error'} = "There was an error decoding the JSON data from Saisei. Bad JSON data logged in error log if debug option was set.";
+ warn "Saisei RC 201 Response Content is not json\n".$client->responseContent()."\n" if $self->option('debug');
return;
}
}
elsif ($client->responseCode() eq '404') {
eval { $result = decode_json($client->responseContent()) };
unless ($result) {
- $self->{'__saisei_error'} = "Error decoding json: $@";
+ $self->{'__saisei_error'} = "There was an error decoding the JSON data from Saisei. Bad JSON data logged in error log if debug option was set.";
+ warn "Saisei RC 404 Response Content is not json\n".$client->responseContent()."\n" if $self->option('debug');
return;
}
## check if message is for empty hash.
my($does_not_exist) = $result->{message} =~ /'(.*)' does not exist$/;
- $self->{'__saisei_error'} = "Error ".$result->{message} unless $does_not_exist;
- warn "Response Content is\n".$client->responseContent."\n" if ($self->option('debug') && !$does_not_exist);
+ $self->{'__saisei_error'} = "Saisei Error: ".$result->{message} unless $does_not_exist;
+ warn "Saisei Response Content is\n".$client->responseContent."\n" if ($self->option('debug') && !$does_not_exist);
return;
}
elsif ($client->responseCode() eq '500') {
- $self->{'__saisei_error'} = "Can't connect to host during $method , received responce code: " . $client->responseCode() . " and message: " . $client->responseContent();
- warn "Response Content is\n".$client->responseContent."\n" if $self->option('debug');
+ $self->{'__saisei_error'} = "Could not connect to the Saisei export host machine (".$self->{Hash}->{machine}.':'.$self->option('port').") during $method , we received the responce code: " . $client->responseCode();
+ warn "Saisei Response Content is\n".$client->responseContent."\n" if $self->option('debug');
return;
}
else {
- $self->{'__saisei_error'} = "Bad response from server during $method , received responce code: " . $client->responseCode() . " and message: " . $client->responseContent();
- warn "Response Content is\n".$client->responseContent."\n" if $self->option('debug');
+ $self->{'__saisei_error'} = "Received Bad response from server during $method $path $data, we received responce code: " . $client->responseCode() . " " . $client->responseContent;
+ warn "Saisei Response Content is\n".$client->responseContent."\n" if $self->option('debug');
return;
}
my $get_policies = $self->api_call("GET", '/policies/?token=1&order=name&start=0&limit=20&select=name%2Cpercent_rate%2Cassured%2C');
return if $self->api_error;
- $self->{'__saisei_error'} = "Did not receive any global policies"
+ $self->{'__saisei_error'} = "Did not receive any global policies from Saisei."
unless $get_policies;
return $get_policies->{collection};
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};
+ $self->{'__saisei_error'} = "There is no download speed set for the service !--service,".$svc->{Hash}->{svcnum}.",".$rateplan."--! with host (".$svc->{Hash}->{ip_addr}."). All services that are to be exported to Saisei need to have a download speed set for them." if !$svc->{Hash}->{speed_down};
+ $self->{'__saisei_error'} = "There is no upload speed set for the service !--service,".$svc->{Hash}->{svcnum}.",".$rateplan."--! with host (".$svc->{Hash}->{ip_addr}."). All services that are to be exported to Saisei need to have a upload speed set for them." if !$svc->{Hash}->{speed_up};
my $new_rateplan = $self->api_call(
"PUT",
},
) unless $self->{'__saisei_error'};
- $self->{'__saisei_error'} = "Rate Plan not created"
+ $self->{'__saisei_error'} = "Saisei could not create the rate plan $rateplan."
unless ($new_rateplan || $self->{'__saisei_error'});
return $new_rateplan;
},
);
- $self->{'__saisei_error'} = "Rate Plan not modified after create"
+ $self->{'__saisei_error'} = "Saisei could not modify the rate plan $rateplan_name after it was created."
unless ($modified_rateplan || $self->{'__saisei_error'}); # should never happen
}
sub api_modify_existing_rateplan {
my ($self,$svc,$rateplan_name) = @_;
+ $self->{'__saisei_error'} = "There is no download speed set for the service !--service,".$svc->{Hash}->{svcnum}.",".$rateplan_name."--! with host (".$svc->{Hash}->{ip_addr}."). All services that are to be exported to Saisei need to have a download speed set for them." if !$svc->{Hash}->{speed_down};
+ $self->{'__saisei_error'} = "There is no upload speed set for the service !--service,".$svc->{Hash}->{svcnum}.",".$rateplan_name."--! with host (".$svc->{Hash}->{ip_addr}."). All services that are to be exported to Saisei need to have a upload speed set for them." if !$svc->{Hash}->{speed_up};
+
my $modified_rateplan = $self->api_call(
"PUT",
"/rate_plans/$rateplan_name",
},
);
- $self->{'__saisei_error'} = "Rate Plan not modified"
+ $self->{'__saisei_error'} = "Saisei could not modify the rate plan $rateplan_name."
unless ($modified_rateplan || $self->{'__saisei_error'}); # should never happen
return;
=cut
sub api_create_user {
- my ($self,$user, $description) = @_;
+ my ($self,$user, $description, $location) = @_;
+
+ my $user_hash = {
+ 'description' => $description,
+ };
+ $user_hash->{'map_location'} = $location if $location;
my $new_user = $self->api_call(
- "PUT",
+ "PUT",
"/users/$user",
- {
- 'description' => $description,
- },
+ $user_hash,
);
- $self->{'__saisei_error'} = "User not created"
+ $self->{'__saisei_error'} = "Saisei could not create the user $user"
unless ($new_user || $self->{'__saisei_error'}); # should never happen
return $new_user;
}
+=head2 api_modify_user
+
+Modify a user.
+
+=cut
+
+sub api_modify_user {
+ my ($self,$user, $description, $location) = @_;
+
+ my $user_hash = {
+ 'description' => $description,
+ };
+ $user_hash->{'map_location'} = $location if $location;
+
+ my $modify_user = $self->api_call(
+ "PUT",
+ "/users/$user",
+ $user_hash,
+ );
+
+ $self->{'__saisei_error'} = "Saisei could not modify the user $user"
+ unless ($modify_user || $self->{'__saisei_error'}); # should never happen
+
+ return $modify_user;
+
+}
+
=head2 api_create_accesspoint
Creates a access point.
=cut
sub api_create_accesspoint {
- my ($self,$accesspoint, $upratelimit, $downratelimit) = @_;
+ my ($self,$accesspoint, $upratelimit, $downratelimit, $location) = @_;
+
+ my $ap_hash = {
+ 'downstream_rate_limit' => $downratelimit,
+ 'upstream_rate_limit' => $upratelimit,
+ 'interface' => $self->option('interface'),
+ };
+ $ap_hash->{'map_location'} = $location if $location;
my $new_accesspoint = $self->api_call(
"PUT",
"/access_points/$accesspoint",
- {
- 'downstream_rate_limit' => $downratelimit,
- 'upstream_rate_limit' => $upratelimit,
- },
+ $ap_hash,
);
- $self->{'__saisei_error'} = "Access point not created"
+ $self->{'__saisei_error'} = "Saisei could not create the access point $accesspoint"
unless ($new_accesspoint || $self->{'__saisei_error'}); # should never happen
return;
=cut
sub api_modify_accesspoint {
- my ($self, $accesspoint, $uplink) = @_;
+ my ($self, $accesspoint, $uplink, $location) = @_;
+
+ my $ap_hash = {
+ 'uplink' => $uplink,
+ 'interface' => $self->option('interface'),
+ };
+ $ap_hash->{'map_location'} = $location if $location;
my $modified_accesspoint = $self->api_call(
"PUT",
"/access_points/$accesspoint",
- {
- 'uplink' => $uplink, # name of attached access point
- },
+ $ap_hash,
);
- $self->{'__saisei_error'} = "Rate Plan not modified"
+ $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint after it was created."
unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
return;
=cut
sub api_modify_existing_accesspoint {
- my ($self, $accesspoint, $uplink, $upratelimit, $downratelimit) = @_;
+ my ($self, $accesspoint, $uplink, $upratelimit, $downratelimit, $location) = @_;
+
+ my $ap_hash = {
+ 'downstream_rate_limit' => $downratelimit,
+ 'upstream_rate_limit' => $upratelimit,
+ 'interface' => $self->option('interface'),
+# 'uplink' => $uplink, # name of attached access point
+ };
+ $ap_hash->{'map_location'} = $location if $location;
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
- },
+ $ap_hash,
);
- $self->{'__saisei_error'} = "Access point not modified"
- unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
+ $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint."
+ unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
return;
=cut
sub api_add_host_to_user {
- my ($self,$user, $rateplan, $ip, $accesspoint) = @_;
+# my ($self,$user, $rateplan, $ip, $accesspoint, $location) = @_;
+ my ($self,$opt) = @_;
+ my $ip = $opt->{'ip'};
+ my $location = $opt->{'location'};
+
+ my $newhost_hash = {
+ 'user' => $opt->{'user'},
+ 'rate_plan' => $opt->{'rateplan'},
+ 'access_point' => $opt->{'accesspoint'},
+ };
+ $newhost_hash->{'map_location'} = $location if $location;
my $new_host = $self->api_call(
"PUT",
"/hosts/$ip",
- {
- 'user' => $user,
- 'rate_plan' => $rateplan,
- 'access_point' => $accesspoint,
- },
+ $newhost_hash,
);
- $self->{'__saisei_error'} = "Host not created"
+ $self->{'__saisei_error'} = "Saisei could not create the host $ip"
unless ($new_host || $self->{'__saisei_error'}); # should never happen
return $new_host;
my $default_rate_plan = $self->api_call("GET", '?token=1&select=default_rate_plan');
return if $self->api_error;
- $self->{'__saisei_error'} = "Did not receive a default rate plan"
+ $self->{'__saisei_error'} = "Can not delete the host as Saisei did not return a default rate plan. Please make sure Saisei has a default rateplan setup."
unless $default_rate_plan;
my $default_rateplan_name = $default_rate_plan->{collection}->[0]->{default_rate_plan}->{link}->{name};
},
);
- $self->{'__saisei_error'} = "Host not created"
+ $self->{'__saisei_error'} = "Saisei could not delete the host $ip"
unless ($delete_host || $self->{'__saisei_error'}); # should never happen
return $delete_host;
my ($self, $opt) = @_;
if (!$opt->{tower_uprate_limit} || !$opt->{tower_downrate_limit}) {
- $self->{'__saisei_error'} = "Can not export tower, no up or down rates attached to tower";
+ $self->{'__saisei_error'} = "Could not export tower !--tower,".$opt->{tower_num}.",".$opt->{tower_name}."--! because there was no up or down rates attached to the tower. Saisei requires a up and down rate be attached to each tower.";
return { error => $self->api_error, };
}
my $existing_tower_ap;
my $tower_name = $opt->{tower_name};
+ my $location = $opt->{location};
#check if tower has been set up as an access point.
$existing_tower_ap = $self->api_get_accesspoint($tower_name) unless $self->{'__saisei_error'};
'', # tower does not have a uplink on sectors.
$opt->{tower_uprate_limit},
$opt->{tower_downrate_limit},
+ $location,
) if $existing_tower_ap->{collection} && $opt->{modify_existing};
#if tower does not exist as an access point create it.
$tower_name,
$opt->{tower_uprate_limit},
$opt->{tower_downrate_limit},
+ $location,
) unless $existing_tower_ap->{collection};
my $accesspoint = $self->api_get_accesspoint($tower_name);
sub process_sector {
my ($self, $opt) = @_;
+ if (!$opt->{sector_name} || $opt->{sector_name} eq '_default') {
+ $self->{'__saisei_error'} = "No sector attached to Tower (".$opt->{tower_name}.") for service ".$opt->{'rateplan'}.". Saisei requires a tower sector to be attached to each service that is exported to Saisei.";
+ return { error => $self->api_error, };
+ }
+
if (!$opt->{sector_uprate_limit} || !$opt->{sector_downrate_limit}) {
- $self->{'__saisei_error'} = "Can not export sector, no up or down rates attached to sector";
+ $self->{'__saisei_error'} = "Could not export sector !--tower,".$opt->{tower_num}.",".$opt->{sector_name}."--! because there was no up or down rates attached to the sector. Saisei requires a up and down rate be attached to each sector.";
return { error => $self->api_error, };
}
my $existing_sector_ap;
my $sector_name = $opt->{sector_name};
+ my $location = $opt->{location};
#check if sector has been set up as an access point.
$existing_sector_ap = $self->api_get_accesspoint($sector_name);
$opt->{tower_name},
$opt->{sector_uprate_limit},
$opt->{sector_downrate_limit},
+ $location,
) if $existing_sector_ap && $opt->{modify_existing};
#if sector does not exist as an access point create it.
$sector_name,
$opt->{sector_uprate_limit},
$opt->{sector_downrate_limit},
+ $location,
) 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);
+ $self->api_modify_accesspoint($sector_name, $opt->{tower_name}, $location) 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;
}
+=head2 get_svc_location
+
+sets location to lat and long from service, if no service location gets it from package, if still no location returns null.
+
+=cut
+
+sub get_svc_location {
+ my ($self, $svc) = @_;
+
+ my $svc_location = '';
+ $svc_location = $svc->{Hash}->{latitude}.','.$svc->{Hash}->{longitude} if ($svc->{Hash}->{latitude} && $svc->{Hash}->{longitude});
+
+ if (!$svc_location) {
+ my $pkg_location = FS::Record::qsearchs({
+ 'table' => 'cust_pkg',
+ 'addl_from' => 'LEFT JOIN cust_location USING (locationnum)',
+ 'hashref' => { 'pkgnum' => $svc->{Hash}->{pkgnum} },
+ });
+ $svc_location = $pkg_location->{Hash}->{latitude}.','.$pkg_location->{Hash}->{longitude} if ($pkg_location->{Hash}->{latitude} && $pkg_location->{Hash}->{longitude});
+ }
+
+ return $svc_location;
+}
+
+=head2 require_tower_and_sector
+
+sets whether the service export requires a sector with it's tower.
+
+=cut
+
+sub require_tower_and_sector {
+ 1;
+}
+
+=head2 tower_sector_required_fields
+
+required fields needed for tower and sector export.
+
+=cut
+
+sub tower_sector_required_fields {
+ my $fields = {
+ 'tower' => {
+ 'up_rate_limit' => '1',
+ 'down_rate_limit' => '1',
+ },
+ 'sector' => {
+ 'up_rate_limit' => '1',
+ 'down_rate_limit' => '1',
+ 'ip_addr' => '1',
+ },
+ };
+ return $fields;
+}
+
+sub required_fields {
+ my @fields = ('svc_broadband__ip_addr_required', 'svc_broadband__speed_up_required', 'svc_broadband__speed_down_required', 'svc_broadband__sectornum_required');
+ return @fields;
+}
+
sub process_virtual_ap {
my ($self, $opt) = @_;
$opt->{sector_name},
$opt->{virtual_uprate_limit},
$opt->{virtual_downrate_limit},
+ $opt->{location},
) if $existing_virtual_ap && $opt->{modify_existing};
#if virtual ap does not exist as an access point create it.
$virtual_name,
$opt->{virtual_uprate_limit},
$opt->{virtual_downrate_limit},
+ $opt->{location},
) unless $existing_virtual_ap;
my $update_sector;
}
# Attach newly created virtual ap to tower sector ap or if sector has changed.
- $self->api_modify_accesspoint($virtual_name, $opt->{sector_name}) unless ($self->{'__saisei_error'} || ($existing_virtual_ap && !$update_sector));
+ $self->api_modify_accesspoint($virtual_name, $opt->{sector_name}, $opt->{location}) unless ($self->{'__saisei_error'} || ($existing_virtual_ap && !$update_sector));
# set access point to existing one or newly created one.
my $accesspoint = $existing_virtual_ap ? $existing_virtual_ap : $self->api_get_accesspoint($virtual_name);
sub export_provisioned_services {
my $job = shift;
my $param = shift;
+ my $force_update = shift;
my $part_export = FS::Record::qsearchs('part_export', { 'exportnum' => $param->{export_provisioned_services_exportnum}, } )
- or die "unknown exportnum $param->{export_provisioned_services_exportnum}";
+ or die "You are trying to use an unknown exportnum $param->{export_provisioned_services_exportnum}. This export does not exist.\n";
bless $part_export;
my @svcparts = FS::Record::qsearch({
if ($status{$process_count}) { my $s = $status{$process_count}; $job->update_statustext($s); }
## check if service exists as host if not export it.
my $host = api_get_host($part_export, $svc->{Hash}->{ip_addr});
- die $host->{message} if $host->{message};
+ die ("Please double check your credentials as ".$host->{message}."\n") if $host->{message};
warn "Exporting service ".$svc->{Hash}->{ip_addr}."\n" if ($part_export->option('debug'));
- my $export_error = _export_insert($part_export,$svc) unless $host->{collection};
- die $export_error if $export_error;
+ my $export_error;
+ if ($force_update) { $export_error = _export_insert($part_export,$svc,$force_update); }
+ else { $export_error = _export_insert($part_export,$svc) unless $host->{collection}; }
+ if ($export_error) {
+ warn "Error exporting service ".$svc->{Hash}->{ip_addr}."\n" if ($part_export->option('debug'));
+ die ("$export_error\n");
+ }
+ $process_count++;
+ }
+
+ return;
+
+}
+
+sub export_all_towers_sectors {
+ my $job = shift;
+ my $param = shift;
+
+ my $part_export = FS::Record::qsearchs('part_export', { 'exportnum' => $param->{export_provisioned_services_exportnum}, } )
+ or die "You are trying to use an unknown exportnum $param->{export_provisioned_services_exportnum}. This export does not exist.\n";
+ bless $part_export;
+
+ my @towers = FS::Record::qsearch({
+ 'table' => 'tower',
+ });
+ my $tower_count = scalar @towers;
+
+ my %status = {};
+ for (my $c=1; $c <=100; $c=$c+1) { $status{int($tower_count * ($c/100))} = $c; }
+
+ my $process_count=0;
+ foreach my $tower (@towers) {
+ if ($status{$process_count}) { my $s = $status{$process_count}; $job->update_statustext($s); }
+ my $export_error = export_tower_sector($part_export,$tower);
+ if ($export_error->{'error'}) {
+ warn "Error exporting tower/sector (".$tower->{Hash}->{towername}.")\n" if ($part_export->option('debug'));
+ die ($export_error->{'error'}."\n");
+ }
$process_count++;
}
}
+sub force_export_all_virtual_ap {
+ my $job = shift;
+ my $param = shift;
+ my $force_update = { 'update_virtual_ap' => '1', };
+
+ export_provisioned_services($job,$param,$force_update);
+
+ return;
+}
+
+sub force_export_all_users {
+ my $job = shift;
+ my $param = shift;
+
+ my $part_export = FS::Record::qsearchs('part_export', { 'exportnum' => $param->{export_provisioned_services_exportnum}, } )
+ or die "You are trying to use an unknown exportnum $param->{export_provisioned_services_exportnum}. This export does not exist.\n";
+ 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."')",
+ }) unless !$parts;
+
+ my $svc_count = scalar @svcs;
+
+ my %status = {};
+ for (my $c=1; $c <=100; $c=$c+1) { $status{int($svc_count * ($c/100))} = $c; }
+
+ my $process_count=0;
+ foreach my $svc (@svcs) {
+ my $description = $svc->{Hash}->{description};
+ my $user = $svc->{Hash}->{svcnum};
+ my $svc_location = get_svc_location($job, $svc);
+ if ($status{$process_count}) { my $s = $status{$process_count}; $job->update_statustext($s); }
+ warn "Exporting user ".$svc->{Hash}->{ip_addr}."\n" if ($part_export->option('debug'));
+ my $export_error = export_user($part_export,$user,$description, $svc_location);
+ if ($export_error) {
+ warn "Error exporting user ".$svc->{Hash}->{svcnum}."\n" if ($part_export->option('debug'));
+ die ($export_error->{'error'}."\n");
+ }
+ $process_count++;
+ }
+
+ return;
+
+}
+
+sub test_export_report {
+ my ($self, $opts) = @_;
+ my @export_error;
+
+ ## check all part services for export errors
+ my @exports = FS::Record::qsearch('part_export', { 'exporttype' => "saisei", } );
+ my $export_nums = join "', '", map { $_->{Hash}->{exportnum} } @exports;
+
+ my $svc_part_export_error;
+ my @svcparts = FS::Record::qsearch({
+ 'table' => 'part_svc',
+ 'addl_from' => 'LEFT JOIN export_svc USING ( svcpart ) ',
+ 'extra_sql' => " WHERE export_svc.exportnum in ('".$export_nums."')",
+ });
+ my $part_count = scalar @svcparts;
+
+ my $svc_part_error;
+ foreach (@svcparts) {
+ my $part_error->{'description'} = $_->svc;
+ $part_error->{'link'} = $opts->{'fsurl'}."/edit/part_svc.cgi?".$_->svcpart;
+
+ foreach my $s ('speed_up', 'speed_down') {
+ my $speed = $_->part_svc_column($s);
+ if ($speed->columnflag eq "" || $speed->columnflag eq "D") {
+ $part_error->{'errors'}->{$speed->columnname} = "Field ".$speed->columnname." is not set to be required and can be set while provisioning the service." unless $speed->required eq "Y";
+ }
+ elsif ($speed->columnflag eq "F" || $speed->columnflag eq "S") {
+ $part_error->{'errors'}->{$speed->columnname} = "Field ".$speed->columnname." is set to auto fill while provisioning the service but there is no value set." unless $speed->columnvalue;
+ }
+ elsif ($speed->columnflag eq "P") {
+ my $fcc_speed_name = "broadband_".$speed->columnvalue."stream";
+ foreach my $part_pkg ( FS::Record::qsearchs({
+ 'table' => 'part_pkg',
+ 'addl_from' => 'LEFT JOIN pkg_svc USING ( pkgpart ) ',
+ 'extra_sql' => " WHERE pkg_svc.svcpart = ".$_->svcpart,
+ })) {
+ my $pkglink = '<a href="'.$opts->{'fsurl'}.'/edit/part_pkg.cgi?'.$part_pkg->pkgpart.'"><FONT COLOR="red"><B>'.$part_pkg->pkg.'</B></FONT></a>';
+ $part_error->{'errors'}->{$speed->columnname} = "Field ".$speed->columnname." is set to package FCC 477 information, but package ".$pkglink." does not have FCC ".$fcc_speed_name." set."
+ unless $part_pkg->fcc_option($fcc_speed_name);
+ }
+ }
+ }
+ $part_error->{'errors'}->{'ip_addr'} = "Field IP Address is not set to required" if $_->part_svc_column("ip_addr")->required ne "Y";
+ $svc_part_error->{$_->svcpart} = $part_error if $part_error->{'errors'};
+ }
+
+ $svc_part_export_error->{"services"}->{'description'} = "Service definitions";
+ $svc_part_export_error->{"services"}->{'count'} = $part_count;
+ $svc_part_export_error->{"services"}->{'errors'} = $svc_part_error if $svc_part_error;
+
+ push @export_error, $svc_part_export_error;
+
+ ## check all provisioned cust services for export errors
+ my $parts = join "', '", map { $_->{Hash}->{svcpart} } @svcparts;
+ my $cust_svc_export_error;
+ my @svcs = FS::Record::qsearch({
+ 'table' => 'cust_svc',
+ 'addl_from' => 'LEFT JOIN svc_broadband USING ( svcnum ) ',
+ 'extra_sql' => " WHERE svcpart in ('".$parts."')",
+ }) unless !$parts;
+ my $svc_count = scalar @svcs;
+
+ my $cust_svc_error;
+ foreach (@svcs) {
+ my $svc_error->{'description'} = $_->description;
+ $svc_error->{'link'} = $opts->{'fsurl'}."/edit/svc_broadband.cgi?".$_->svcnum;
+
+ foreach my $s ('speed_up', 'speed_down', 'ip_addr') {
+ $svc_error->{'errors'}->{$s} = "Field ".$s." is not set and is required for this service to be exported to Saisei." unless $_->$s;
+ }
+
+ my $sector = FS::Record::qsearchs({
+ 'table' => 'tower_sector',
+ 'extra_sql' => " WHERE sectornum = ".$_->sectornum." AND sectorname != '_default'",
+ }) if $_->sectornum;
+ if (!$sector) {
+ $svc_error->{'errors'}->{'sectornum'} = "No tower sector is set for this service. There needs to be a tower and sector set to be exported to Saisei.";
+ }
+ else {
+ foreach my $s ('up_rate_limit', 'down_rate_limit') {
+ $svc_error->{'errors'}->{'sectornum'} = "The sector ".$sector->description." does not have a ".$s." set. The sector needs a ".$s." set to be exported to Saisei."
+ unless $sector->$s;
+ }
+ }
+ $cust_svc_error->{$_->svcnum} = $svc_error if $svc_error->{'errors'};
+ }
+
+ $cust_svc_export_error->{"provisioned_services"}->{'description'} = "Provisioned services";
+ $cust_svc_export_error->{"provisioned_services"}->{'count'} = $svc_count;
+ $cust_svc_export_error->{"provisioned_services"}->{'errors'} = $cust_svc_error if $cust_svc_error;
+
+ push @export_error, $cust_svc_export_error;
+
+
+ ## check all towers and sectors for export errors
+ my $tower_sector_export_error;
+ my @towers = FS::Record::qsearch({
+ 'table' => 'tower',
+ });
+ my $tower_count = scalar @towers;
+
+ my $towers_error;
+ foreach (@towers) {
+ my $tower_error->{'description'} = $_->towername;
+ $tower_error->{'link'} = $opts->{'fsurl'}."/edit/tower.html?".$_->towernum;
+
+ foreach my $s ('up_rate_limit', 'down_rate_limit') {
+ $tower_error->{'errors'}->{$s} = "Field ".$s." is not set for the tower, this is required for this tower to be exported to Saisei." unless $_->$s;
+ }
+
+ my @sectors = FS::Record::qsearch({
+ 'table' => 'tower_sector',
+ 'extra_sql' => " WHERE towernum = ".$_->towernum." AND sectorname != '_default' AND (up_rate_limit IS NULL OR down_rate_limit IS NULL)",
+ }) if $_->towernum;
+ foreach my $sector (@sectors) {
+ foreach my $s ('up_rate_limit', 'down_rate_limit') {
+ $tower_error->{'errors'}->{'sector_'.$s} = "The sector ".$sector->description." does not have a ".$s." set. The sector needs a ".$s." set to be exported to Saisei."
+ if !$sector->$s;
+ }
+ }
+ $towers_error->{$_->towernum} = $tower_error if $tower_error->{'errors'};
+ }
+
+ $tower_sector_export_error->{"tower_sector"}->{'description'} = "Tower / Sector";
+ $tower_sector_export_error->{"tower_sector"}->{'count'} = $tower_count;
+ $tower_sector_export_error->{"tower_sector"}->{'errors'} = $towers_error if $towers_error;
+
+ push @export_error, $tower_sector_export_error;
+
+ return [@export_error];
+
+}
+
=head1 SEE ALSO
L<FS::part_export>
projects / freeside.git / blobdiff