<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

FS::svc_fiber

NAME

FS::svc_fiber - Object methods for svc_fiber records

SYNOPSIS

  use FS::table_name;

  $record = new FS::table_name \%hash;
  $record = new FS::table_name { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

  $error = $record->suspend;

  $error = $record->unsuspend;

  $error = $record->cancel;

DESCRIPTION

An FS::svc_fiber object represents a fiber-to-the-premises service. FS::svc_fiber inherits from FS::svc_Common. The following fields are currently supported:

svcnum - Primary key
oltnum - The Optical Line Terminal this service connects to (see FS::fiber_olt).
shelf - The shelf number on the OLT.
card - The card number on the OLT shelf.
olt_port - The port number on that card.
vlan - The VLAN number.
signal - Measured signal strength in dB.
speed_up - Measured uplink speed in Mbps.
speed_down - Measured downlink speed in Mbps.

METHODS

new HASHREF

Creates a new fiber service record. To add it to the database, see "insert".

search_sql STRING

Class method which returns an SQL fragment to search for the given string. For svc_fiber, STRING can be a full or partial ONT serial number.

label

Returns a description of this fiber service containing the ONT serial number and the OLT name and port location.

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

The additional fields pkgnum and svcpart (see FS::cust_svc) should be defined. An FS::cust_svc record will be created and inserted.

delete

Delete this record from the database.

replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.

suspend

Called by the suspend method of FS::cust_pkg (see FS::cust_pkg).

unsuspend

Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg).

cancel

Called by the cancel method of FS::cust_pkg (see FS::cust_pkg).

check

Checks all fields to make sure this is a valid example. If there is an error, returns the error, otherwise returns false. Called by the insert and repalce methods.

ont_description

Returns the description of the ONT hardware, if there is one.

search HASHREF

Returns a qsearch hash expression to search for parameters specified in HASHREF.

Parameters are those in "search" in FS::svc_Common, plus:

ont_typenum - the ONT FS::hardware_type key

oltnum - the OLT FS::fiber_olt key

shelf, card, olt_port - the OLT port location fields

vlan - the VLAN number

ont_serial - the ONT serial number

SEE ALSO

FS::svc_Common, FS::Record, FS::cust_svc, FS::part_svc, FS::cust_pkg, schema.html from the base documentation.

<% include ('/elements/footer.html' ) %>