FS::part_export - Object methods for part_export records
use FS::part_export;
$record = new FS::part_export \%hash;
$record = new FS::part_export { 'column' => 'value' };
#($new_record, $options) = $template_recored->clone( $svcpart );
$error = $record->insert( { 'option' => 'value' } );
$error = $record->insert( \%options );
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::part_export object represents an export of Freeside data to an external provisioning system. FS::part_export inherits from FS::Record. The following fields are currently supported:
Creates a new export. To add the export to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
If a hash reference of options is supplied, part_export_option records are created (see FS::part_export_option).
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
If a list or hash reference of options is supplied, option records are created or modified.
Checks all fields to make sure this is a valid export. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns a label for this export, "exportname||exportype (machine)".
Returns a label for this export, "exportname: exporttype to machine".
Returns a list of associated FS::svc_* records.
Returns a list of associated FS::cust_svc records.
Returns all machines as FS::part_export_machine objects (see FS::part_export_machine).
Returns a list of associated FS::export_svc records.
Returns a list of associated FS::export_device records.
Returns all options as FS::part_export_option objects (see FS::part_export_option).
Returns a list of option names and values suitable for assigning to a hash.
Returns the option value for the given name, or the empty string.
Reblesses the object into the FS::part_export::EXPORTTYPE class, where EXPORTTYPE is the object's exporttype field. There should be better docs on how to create new exports, but until then, see "NEW EXPORT CLASSES".
Return the export hostname for SVC_X.
Return the default export hostname for this export.
Returns the remote id for this export for the given service.
Sets the remote id for this export for the given service. See FS::export_cust_svc.
If value is true, inserts or updates export_cust_svc record. If value is false, deletes any existing record.
Returns error message, blank on success.
Adds a list of web elements to ARRAYREF specific to this export and SVC_OBJECT. The elements are displayed in the UI to lead the the operator to external configuration, monitoring, and similar tools.
Adds a hashref of settings to SETTINGSREF specific to this export and SVC_OBJECT. The elements can be displayed in the UI on the service view.
DEFAULTSREF is a hashref with the same keys where true values indicate the setting is a default (and thus can be displayed in the UI with less emphasis, or hidden by default).
Adds one or more "action" links to the export's display in browse/part_export.cgi. Should return pairs of values. The first is the link label; the second is the Mason path to a document to load. The document will show in a popup.
Returns the 'weight' element from the export's %info hash, or 0 if there is no weight defined.
Returns a reference to (a copy of) the export's %info hash.
Does several things, which is unfortunate. DID phone numbers are organized in a sort-of hierarchy: state, areacode, exchange, number. Or, for some vendors: state, region, number. But not always that, either.
SELECTION is one or more field/value pairs specifying parts of the hierarchy that have already been selected. get_dids will then return an arrayref of the possible values for the next selection level. Note that these are not actual DIDs except at the lowest level.
Generally, 'state' alone will return an array of area codes or region names in the state.
'state' and 'areacode' together will return an array of either: - exchange strings of the form "New York (212-555-XXXX)" - ratecenter names of the form "New York, NY"
These strings are sent back to the UI and offered as options so that the user can choose the local calling area they like.
'areacode' and 'exchange', or 'state' and 'ratecenter', or 'region' by itself will return an array of actual DID numbers.
Passing 'tollfree' with a true value will override the whole hierarchy and return an array of tollfree numbers.
get_dids methods should report errors via die().
Returns the role that SVC occupies with respect to this export, if any. This is part of the part_svc's export configuration.
Given a svc_* object SVC or pkgnum PKG, and a role name ROLE, finds the service(s) in the same package that are linked to this export with ROLE.
Returns a hash reference of the exports for the given svcdb, or if no svcdb is specified, for all exports. The keys of the hash are exporttypes and the values are again hash references containing information on the export:
'desc' => 'Description',
'options' => {
'option' => { label=>'Option Label' },
'option2' => { label=>'Another label' },
},
'nodomain' => 'Y', #or ''
'notes' => 'Additional notes',
A module should be added in FS/FS/part_export/ (an example may be found in eg/export_template.pm)
Hmm... cust_export class (not necessarily a database table...) ... ?
deprecated column...
FS::part_export_option, FS::export_svc, FS::svc_acct, FS::svc_domain, FS::svc_forward, FS::Record, schema.html from the base documentation.
Hey! The above document had some coding errors, which are explained below:
=cut found outside a pod block. Skipping to next block.
=cut found outside a pod block. Skipping to next block.