package FS::Conf;
-use vars qw($base_dir @config_items @base_items @card_types $DEBUG);
+use strict;
+use vars qw( $base_dir @config_items @base_items @card_types @invoice_terms
+ $DEBUG
+ $conf_cache $conf_cache_enabled
+ );
use Carp;
use IO::File;
use File::Basename;
use Locale::Currency;
use FS::ConfItem;
use FS::ConfDefaults;
-use FS::Conf_compat17;
use FS::Locales;
use FS::payby;
use FS::conf;
use FS::Record qw(qsearch qsearchs);
-use FS::UID qw(dbh datasrc use_confcompat);
+use FS::UID qw(dbh datasrc);
use FS::Misc::Invoicing qw( spool_formats );
$base_dir = '%%%FREESIDE_CONF%%%';
$DEBUG = 0;
+$conf_cache_enabled = 0;
+
=head1 NAME
FS::Conf - Freeside configuration values
=cut
-sub _usecompat {
- my ($self, $method) = (shift, shift);
- carp "NO CONFIGURATION RECORDS FOUND -- USING COMPATIBILITY MODE"
- if use_confcompat;
- my $compat = new FS::Conf_compat17 ("$base_dir/conf." . datasrc);
- $compat->$method(@_);
-}
-
sub _config {
my($self,$name,$agentnum,$agentonly)=@_;
my $hashref = { 'name' => $name };
local $FS::Record::conf = undef; # XXX evil hack prevents recursion
+ $conf_cache = undef unless $conf_cache_enabled; # use cache only when it is
+ # safe to do so
my $cv;
my @a = (
($agentnum || ()),
foreach my $a (@a) {
$hashref->{agentnum} = $a;
foreach my $l (@l) {
- $hashref->{locale} = $l;
- $cv = FS::Record::qsearchs('conf', $hashref);
- return $cv if $cv;
+ my $key = join(':',$name, $a, $l);
+ if (! exists $conf_cache->{$key}){
+ $hashref->{locale} = $l;
+ # $conf_cache is reset in FS::UID during myconnect, so the cache is
+ # reset per connection
+ $conf_cache->{$key} = FS::Record::qsearchs('conf', $hashref);
+ }
+ return $conf_cache->{$key} if $conf_cache->{$key};
}
}
return undef;
sub config {
my $self = shift;
- return $self->_usecompat('config', @_) if use_confcompat;
carp "FS::Conf->config(". join(', ', @_). ") called"
if $DEBUG > 1;
sub config_binary {
my $self = shift;
- return $self->_usecompat('config_binary', @_) if use_confcompat;
my $cv = $self->_config(@_) or return;
length($cv->value) ? decode_base64($cv->value) : '';
sub exists {
my $self = shift;
- return $self->_usecompat('exists', @_) if use_confcompat;
#my($name, $agentnum)=@_;
sub config_bool {
my $self = shift;
- return $self->_usecompat('exists', @_) if use_confcompat;
my($name,$agentnum,$agentonly) = @_;
# these to fall back to standard values
sub config_orbase {
my $self = shift;
- return $self->_usecompat('config_orbase', @_) if use_confcompat;
my( $name, $suffix ) = @_;
if ( $self->exists("${name}_$suffix") ) {
sub key_orbase {
my $self = shift;
- #no compat for this...return $self->_usecompat('config_orbase', @_) if use_confcompat;
my( $name, $suffix ) = @_;
if ( $self->exists("${name}_$suffix") ) {
sub touch {
my $self = shift;
- return $self->_usecompat('touch', @_) if use_confcompat;
my($name, $agentnum) = @_;
#unless ( $self->exists($name, $agentnum) ) {
sub set {
my $self = shift;
- return $self->_usecompat('set', @_) if use_confcompat;
my($name, $value, $agentnum) = @_;
$value =~ /^(.*)$/s;
$error = $new->insert;
}
+ if (! $error) {
+ # clean the object cache
+ my $key = join(':',$name, $agentnum, $self->{locale});
+ $conf_cache->{ $key } = $new;
+ }
+
die "error setting configuration value: $error \n"
if $error;
sub set_binary {
my $self = shift;
- return if use_confcompat;
my($name, $value, $agentnum)=@_;
$self->set($name, encode_base64($value), $agentnum);
sub delete {
my $self = shift;
- return $self->_usecompat('delete', @_) if use_confcompat;
my($name, $agentnum) = @_;
if ( my $cv = FS::Record::qsearchs('conf', {name => $name, agentnum => $agentnum, locale => $self->{locale}}) ) {
sub delete_bool {
my $self = shift;
- return $self->_usecompat('delete', @_) if use_confcompat;
my($name, $agentnum) = @_;
sub import_config_item {
my ($self,$item,$dir) = @_;
my $key = $item->key;
- if ( -e "$dir/$key" && ! use_confcompat ) {
+ if ( -e "$dir/$key" ) {
warn "Inserting $key\n" if $DEBUG;
local $/;
my $value = readline(new IO::File "$dir/$key");
}else{
$self->set($key, $value);
}
- }else {
- warn "Not inserting $key\n" if $DEBUG;
- }
-}
-
-=item verify_config_item CONFITEM DIR
-
- Compares the item specified by the CONFITEM (see L<FS::ConfItem>) in
-the database to the legacy file value in DIR.
-
-=cut
-
-sub verify_config_item {
- return '' if use_confcompat;
- my ($self,$item,$dir) = @_;
- my $key = $item->key;
- my $type = $item->type;
-
- my $compat = new FS::Conf_compat17 $dir;
- my $error = '';
-
- $error .= "$key fails existential comparison; "
- if $self->exists($key) xor $compat->exists($key);
-
- if ( $type !~ /^(binary|image)$/ ) {
-
- {
- no warnings;
- $error .= "$key fails scalar comparison; "
- unless scalar($self->config($key)) eq scalar($compat->config($key));
- }
-
- my (@new) = $self->config($key);
- my (@old) = $compat->config($key);
- unless ( scalar(@new) == scalar(@old)) {
- $error .= "$key fails list comparison; ";
- }else{
- my $r=1;
- foreach (@old) { $r=0 if ($_ cmp shift(@new)); }
- $error .= "$key fails list comparison; "
- unless $r;
- }
-
} else {
-
- no warnings 'uninitialized';
- $error .= "$key fails binary comparison; "
- unless scalar($self->config_binary($key)) eq scalar($compat->config_binary($key));
-
+ warn "Not inserting $key\n" if $DEBUG;
}
-
-#remove deprecated config on our own terms, not freeside-upgrade's
-# if ($error =~ /existential comparison/ && $item->section eq 'deprecated') {
-# my $proto;
-# for ( @config_items ) { $proto = $_; last if $proto->key eq $key; }
-# unless ($proto->key eq $key) {
-# warn "removed config item $error\n" if $DEBUG;
-# $error = '';
-# }
-# }
-
- $error;
}
#item _orbase_items OPTIONS
'key' => $_,
'base_key' => $proto->key,
'section' => $proto->section,
- 'description' => 'Alternate ' . $proto->description . ' See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Administration#Invoice_templates">billing documentation</a> for details.',
+ 'description' => 'Alternate ' . $proto->description . ' See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Administration#Invoice_templates">billing documentation</a> for details.',
'type' => $proto->type,
};
} &$listmaker($base);
sub config_items {
my $self = shift;
- return $self->_usecompat('config_items', @_) if use_confcompat;
( @config_items, $self->_orbase_items(@_) );
}
+=item invoice_from_full [ AGENTNUM ]
+
+Returns values of invoice_from and invoice_from_name (or, if that is not
+defined, company_name), appropriately combined based on their current values.
+
+=cut
+
+sub invoice_from_full {
+ my ($self, $agentnum) = @_;
+
+ ( $self->config('invoice_from_name', $agentnum)
+ || $self->config('company_name', $agentnum)
+ ).
+ ' <'. $self->config('invoice_from', $agentnum ). '>';
+}
+
=back
=head1 SUBROUTINES
sub init_config {
my $dir = shift;
- {
- local $FS::UID::use_confcompat = 0;
- my $conf = new FS::Conf;
- foreach my $item ( $conf->config_items(dir => $dir) ) {
- $conf->import_config_item($item, $dir);
- my $error = $conf->verify_config_item($item, $dir);
- return $error if $error;
- }
-
- my $compat = new FS::Conf_compat17 $dir;
- foreach my $item ( $compat->config_items ) {
- my $error = $conf->verify_config_item($item, $dir);
- return $error if $error;
- }
+ my $conf = new FS::Conf;
+ foreach my $item ( $conf->config_items(dir => $dir) ) {
+ $conf->import_config_item($item, $dir);
}
- $FS::UID::use_confcompat = 0;
''; #success
}
invoice_latexsmallfooter
invoice_latexnotes
invoice_latexcoupon
+invoice_latexwatermark
invoice_html
invoice_htmlreturnaddress
invoice_htmlfooter
invoice_htmlnotes
+invoice_htmlwatermark
logo.png
logo.eps
);
+@invoice_terms = (
+ '',
+ 'Payable upon receipt',
+ 'Net 0', 'Net 3', 'Net 5', 'Net 7', 'Net 9', 'Net 10', 'Net 14',
+ 'Net 15', 'Net 18', 'Net 20', 'Net 21', 'Net 25', 'Net 30', 'Net 45',
+ 'Net 60', 'Net 90'
+);
+
my %msg_template_options = (
'type' => 'select-sub',
'options_sub' => sub {
},
);
+my %invoice_mode_options = (
+ 'type' => 'select-sub',
+ 'options_sub' => sub {
+ my @modes = qsearch({
+ 'table' => 'invoice_mode',
+ 'extra_sql' => ' WHERE '.
+ $FS::CurrentUser::CurrentUser->agentnums_sql(null => 1),
+ });
+ map { $_->modenum, $_->modename } @modes;
+ },
+ 'option_sub' => sub {
+ my $mode = FS::invoice_mode->by_key(shift);
+ $mode ? $mode->modename : '',
+ },
+ 'per_agent' => 1,
+);
+
my @cdr_formats = (
'' => '',
'default' => 'Default',
}
}
+my $validate_email = sub { $_[0] =~
+ /^[^@]+\@[[:alnum:]-]+(\.[[:alnum:]-]+)+$/
+ ? '' : 'Invalid email address';
+ };
+
#Billing (81 items)
#Invoicing (50 items)
#UI (69 items)
@config_items = map { new FS::ConfItem $_ } (
{
- 'key' => 'address',
- 'section' => 'deprecated',
- 'description' => 'This configuration option is no longer used. See <a href="#invoice_template">invoice_template</a> instead.',
- 'type' => 'text',
- },
-
- {
'key' => 'event_log_level',
'section' => 'notification',
'description' => 'Store events in the internal log if they are at least this severe. "info" is the default, "debug" is very detailed and noisy.',
{
'key' => 'log_sent_mail',
'section' => 'notification',
- 'description' => 'Enable logging of template-generated email.',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'alert_expiration',
- 'section' => 'deprecated',
- 'description' => 'Enable alerts about credit card expiration. This is obsolete and no longer works.',
+ 'description' => 'Enable logging of all sent email.',
'type' => 'checkbox',
- 'per_agent' => 1,
- },
-
- {
- 'key' => 'alerter_template',
- 'section' => 'deprecated',
- 'description' => 'Template file for billing method expiration alerts (i.e. expiring credit cards).',
- 'type' => 'textarea',
- 'per_agent' => 1,
- },
-
- {
- 'key' => 'alerter_msgnum',
- 'section' => 'deprecated',
- 'description' => 'Template to use for credit card expiration alerts.',
- %msg_template_options,
},
{
'key' => 'part_pkg-lineage',
- 'section' => '',
+ 'section' => 'packages',
'description' => 'When editing a package definition, if setup or recur fees are changed, create a new package rather than changing the existing package.',
'type' => 'checkbox',
},
#not actually deprecated yet
#'section' => 'deprecated',
#'description' => '<b>DEPRECATED</b>, add an <i>apache</i> <a href="../browse/part_export.cgi">export</a> instead. Used to be the current IP address to assign to new virtual hosts',
- 'section' => '',
+ 'section' => 'services',
'description' => 'IP address to assign to new virtual hosts',
'type' => 'text',
},
{
'key' => 'credit-card-surcharge-percentage',
- 'section' => 'billing',
- 'description' => 'Add a credit card surcharge to invoices, as a % of the invoice total. WARNING: this is usually prohibited by merchant account / other agreements and/or law, but is currently lawful in AU and UK.',
+ 'section' => 'credit_cards',
+ 'description' => 'Add a credit card surcharge to invoices, as a % of the invoice total. WARNING: Although recently permitted to US merchants in general, specific consumer protection laws may prohibit or restrict this practice in California, Colorado, Connecticut, Florda, Kansas, Maine, Massachusetts, New York, Oklahome, and Texas. Surcharging is also generally prohibited in most countries outside the US, AU and UK. When allowed, typically not permitted to be above 4%.',
'type' => 'text',
+ 'per_agent' => 1,
},
{
'key' => 'discount-show-always',
- 'section' => 'billing',
+ 'section' => 'invoicing',
'description' => 'Generate a line item on an invoice even when a package is discounted 100%',
'type' => 'checkbox',
},
{
'key' => 'discount-show_available',
- 'section' => 'billing',
+ 'section' => 'invoicing',
'description' => 'Show available prepayment discounts on invoices.',
'type' => 'checkbox',
},
{
'key' => 'invoice-barcode',
- 'section' => 'billing',
+ 'section' => 'invoicing',
'description' => 'Display a barcode on HTML and PDF invoices',
'type' => 'checkbox',
},
{
'key' => 'cust_main-select-billday',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => 'When used with a specific billing event, allows the selection of the day of month on which to charge credit card / bank account automatically, on a per-customer basis',
'type' => 'checkbox',
},
{
'key' => 'encryption',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Enable encryption of credit cards and echeck numbers',
'type' => 'checkbox',
},
{
'key' => 'encryptionmodule',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Use which module for encryption?',
'type' => 'select',
'select_enum' => [ '', 'Crypt::OpenSSL::RSA', ],
{
'key' => 'encryptionpublickey',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Encryption public key',
'type' => 'textarea',
},
{
'key' => 'encryptionprivatekey',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Encryption private key',
'type' => 'textarea',
},
{
'key' => 'billco-url',
- 'section' => 'billing',
+ 'section' => 'print_services',
'description' => 'The url to use for performing uploads to the invoice mailing service.',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'billco-username',
- 'section' => 'billing',
+ 'section' => 'print_services',
'description' => 'The login name to use for uploads to the invoice mailing service.',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'billco-password',
- 'section' => 'billing',
+ 'section' => 'print_services',
'description' => 'The password to use for uploads to the invoice mailing service.',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'billco-clicode',
- 'section' => 'billing',
+ 'section' => 'print_services',
'description' => 'The clicode to use for uploads to the invoice mailing service.',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'billco-account_num',
- 'section' => 'billing',
+ 'section' => 'print_services',
'description' => 'The data to place in the "Transaction Account No" / "TRACCTNUM" field.',
'type' => 'select',
'select_hash' => [
{
'key' => 'business-onlinepayment',
- 'section' => 'billing',
- 'description' => '<a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a> support, at least three lines: processor, login, and password. An optional fourth line specifies the action or actions (multiple actions are separated with `,\': for example: `Authorization Only, Post Authorization\'). Optional additional lines are passed to Business::OnlinePayment as %processor_options.',
+ 'section' => 'credit_cards',
+ 'description' => '<a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a> support, at least three lines: processor, login, and password. An optional fourth line specifies the action or actions (multiple actions are separated with `,\': for example: `Authorization Only, Post Authorization\'). Optional additional lines are passed to Business::OnlinePayment as %processor_options. For more detailed information and examples see the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Administration:Real-time_Processing">real-time credit card processing documentation</a>.',
'type' => 'textarea',
},
{
'key' => 'business-onlinepayment-ach',
- 'section' => 'billing',
+ 'section' => 'e-checks',
'description' => 'Alternate <a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a> support for ACH transactions (defaults to regular <b>business-onlinepayment</b>). At least three lines: processor, login, and password. An optional fourth line specifies the action or actions (multiple actions are separated with `,\': for example: `Authorization Only, Post Authorization\'). Optional additional lines are passed to Business::OnlinePayment as %processor_options.',
'type' => 'textarea',
},
{
'key' => 'business-onlinepayment-namespace',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Specifies which perl module namespace (which group of collection routines) is used by default.',
'type' => 'select',
'select_hash' => [
{
'key' => 'business-onlinepayment-description',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'String passed as the description field to <a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a>. Evaluated as a double-quoted perl string, with the following variables available: <code>$agent</code> (the agent name), and <code>$pkgs</code> (a comma-separated list of packages for which these charges apply - not available in all situations)',
'type' => 'text',
},
{
'key' => 'business-onlinepayment-email-override',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Email address used instead of customer email address when submitting a BOP transaction.',
'type' => 'text',
},
{
'key' => 'business-onlinepayment-email_customer',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Controls the "email_customer" flag used by some Business::OnlinePayment processors to enable customer receipts.',
'type' => 'checkbox',
},
{
'key' => 'business-onlinepayment-test_transaction',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Turns on the Business::OnlinePayment test_transaction flag. Note that not all gateway modules support this flag; if yours does not, transactions will still be sent live.',
'type' => 'checkbox',
},
{
'key' => 'business-onlinepayment-currency',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Currency parameter for Business::OnlinePayment transactions.',
'type' => 'select',
- 'select_enum' => [ '', qw( USD AUD CAD DKK EUR GBP ILS JPY NZD ) ],
+ 'select_enum' => [ '', qw( USD AUD CAD DKK EUR GBP ILS JPY NZD ARS ) ],
+ },
+
+ {
+ 'key' => 'business-onlinepayment-verification',
+ 'section' => 'credit_cards',
+ 'description' => 'Run a $1 authorization (followed by a void) to verify new credit card information.',
+ 'type' => 'checkbox',
},
{
'key' => 'currency',
- 'section' => 'billing',
+ 'section' => 'localization',
'description' => 'Main accounting currency',
'type' => 'select',
- 'select_enum' => [ '', qw( USD AUD CAD DKK EUR GBP ILS JPY NZD XAF ) ],
+ 'select_enum' => [ '', qw( USD AUD CAD DKK EUR GBP ILS JPY NZD XAF ARS ) ],
},
{
'key' => 'currencies',
- 'section' => 'billing',
+ 'section' => 'localization',
'description' => 'Additional accepted currencies',
'type' => 'select-sub',
'multiple' => 1,
{
'key' => 'business-batchpayment-test_transaction',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Turns on the Business::BatchPayment test_mode flag. Note that not all gateway modules support this flag; if yours does not, using the batch gateway will fail.',
'type' => 'checkbox',
},
{
'key' => 'countrydefault',
- 'section' => 'UI',
+ 'section' => 'localization',
'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
'type' => 'text',
},
{
'key' => 'date_format',
- 'section' => 'UI',
+ 'section' => 'localization',
'description' => 'Format for displaying dates',
'type' => 'select',
'select_hash' => [
'%m/%d/%Y' => 'MM/DD/YYYY',
'%d/%m/%Y' => 'DD/MM/YYYY',
'%Y/%m/%d' => 'YYYY/MM/DD',
+ '%e %b %Y' => 'DD Mon YYYY',
],
+ 'per_locale' => 1,
},
{
'key' => 'date_format_long',
- 'section' => 'UI',
+ 'section' => 'localization',
'description' => 'Verbose format for displaying dates',
'type' => 'select',
'select_hash' => [
'%d/%m/%Y' => 'DD/MM/YYYY',
'%Y/%m/%d' => 'YYYY/MM/DD',
],
- },
-
- {
- 'key' => 'deleteinvoices',
- 'section' => 'UI',
- 'description' => 'Enable invoices deletions. Be very careful! Deleting an invoice will remove all traces that the invoice ever existed! Normally, you would void or apply a credit against the invoice instead.',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'deletecredits',
- #not actually deprecated yet
- #'section' => 'deprecated',
- #'description' => '<B>DEPRECATED</B>, now controlled by ACLs. Used to enable deletion of unclosed credits. Be very careful! Only delete credits that were data-entry errors, not adjustments. Optionally specify one or more comma-separated email addresses to be notified when a credit is deleted.',
- 'section' => '',
- 'description' => 'One or more comma-separated email addresses to be notified when a credit is deleted.',
- 'type' => [qw( checkbox text )],
+ 'per_locale' => 1,
},
{
},
{
- 'key' => 'unapplypayments',
- 'section' => 'deprecated',
- 'description' => '<B>DEPRECATED</B>, now controlled by ACLs. Used to enable "unapplication" of unclosed payments.',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'unapplycredits',
- 'section' => 'deprecated',
- 'description' => '<B>DEPRECATED</B>, now controlled by ACLs. Used to nable "unapplication" of unclosed credits.',
- 'type' => 'checkbox',
- },
-
- {
'key' => 'dirhash',
'section' => 'shell',
'description' => 'Optional numeric value to control directory hashing. If positive, hashes directories for the specified number of levels from the front of the username. If negative, hashes directories for the specified number of levels from the end of the username. Some examples: <ul><li>1: user -> <a href="#home">/home</a>/u/user<li>2: user -> <a href="#home">/home</a>/u/s/user<li>-1: user -> <a href="#home">/home</a>/r/user<li>-2: user -> <a href="#home">home</a>/r/e/user</ul>',
{
'key' => 'disable_cust_attachment',
- 'section' => '',
+ 'section' => 'notes',
'description' => 'Disable customer file attachments',
'type' => 'checkbox',
},
{
'key' => 'max_attachment_size',
- 'section' => '',
+ 'section' => 'notes',
'description' => 'Maximum size for customer file attachments (leave blank for unlimited)',
'type' => 'text',
},
{
'key' => 'disable_customer_referrals',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Disable new customer-to-customer referrals in the web interface',
'type' => 'checkbox',
},
{
'key' => 'editreferrals',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Enable advertising source modification for existing customers',
'type' => 'checkbox',
},
{
'key' => 'emailinvoiceonly',
- 'section' => 'invoicing',
+ 'section' => 'invoice_email',
'description' => 'Disables postal mail invoices',
'type' => 'checkbox',
},
{
'key' => 'emailinvoiceauto',
- 'section' => 'invoicing',
+ 'section' => 'invoice_email',
'description' => 'Automatically adds new accounts to the email invoice list',
'type' => 'checkbox',
},
{
'key' => 'emailinvoiceautoalways',
- 'section' => 'invoicing',
+ 'section' => 'invoice_email',
'description' => 'Automatically adds new accounts to the email invoice list even when the list contains email addresses',
'type' => 'checkbox',
},
{
'key' => 'emailinvoice-apostrophe',
- 'section' => 'invoicing',
+ 'section' => 'invoice_email',
'description' => 'Allows the apostrophe (single quote) character in the email addresses in the email invoice list.',
'type' => 'checkbox',
},
{
'key' => 'svc_acct-ip_addr',
- 'section' => '',
+ 'section' => 'services',
'description' => 'Enable IP address management on login services like for broadband services.',
'type' => 'checkbox',
},
{
'key' => 'exclude_ip_addr',
- 'section' => '',
- 'description' => 'Exclude these from the list of available broadband service IP addresses. (One per line)',
+ 'section' => 'services',
+ 'description' => 'Exclude these from the list of available IP addresses. (One per line)',
'type' => 'textarea',
},
{
'key' => 'auto_router',
- 'section' => '',
+ 'section' => 'wireless_broadband',
'description' => 'Automatically choose the correct router/block based on supplied ip address when possible while provisioning broadband services',
'type' => 'checkbox',
},
{
'key' => 'hidecancelledpackages',
- 'section' => 'UI',
+ 'section' => 'cancellation',
'description' => 'Prevent cancelled packages from showing up in listings (though they will still be in the database)',
'type' => 'checkbox',
},
{
'key' => 'hidecancelledcustomers',
- 'section' => 'UI',
+ 'section' => 'cancellation',
'description' => 'Prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
'type' => 'checkbox',
},
{
'key' => 'invoice_from',
- 'section' => 'required',
- 'description' => 'Return address on email invoices',
+ 'section' => 'important',
+ 'description' => 'Return address on email invoices ("user@domain" only)',
'type' => 'text',
'per_agent' => 1,
+ 'validate' => $validate_email,
},
{
+ 'key' => 'invoice_from_name',
+ 'section' => 'invoice_email',
+ 'description' => 'Return name on email invoices (set address in invoice_from)',
+ 'type' => 'text',
+ 'per_agent' => 1,
+ 'validate' => sub { (($_[0] =~ /[^[:alnum:][:space:]]/) && ($_[0] !~ /^\".*\"$/))
+ ? 'Invalid name. Use quotation marks around names that contain punctuation.'
+ : '' }
+ },
+
+ {
+ 'key' => 'quotation_from',
+ 'section' => 'quotations',
+ 'description' => 'Return address on email quotations',
+ 'type' => 'text',
+ 'per_agent' => 1,
+ },
+
+
+ {
'key' => 'invoice_subject',
- 'section' => 'invoicing',
+ 'section' => 'invoice_email',
'description' => 'Subject: header on email invoices. Defaults to "Invoice". The following substitutions are available: $name, $name_short, $invoice_number, and $invoice_date.',
'type' => 'text',
'per_agent' => 1,
},
{
+ 'key' => 'quotation_subject',
+ 'section' => 'quotations',
+ 'description' => 'Subject: header on email quotations. Defaults to "Quotation".', # The following substitutions are available: $name, $name_short, $invoice_number, and $invoice_date.',
+ 'type' => 'text',
+ #'per_agent' => 1,
+ 'per_locale' => 1,
+ },
+
+ {
'key' => 'invoice_usesummary',
'section' => 'invoicing',
'description' => 'Indicates that html and latex invoices should be in summary style and make use of invoice_latexsummary.',
{
'key' => 'invoice_template',
- 'section' => 'invoicing',
- 'description' => 'Text template file for invoices. Used if no invoice_html template is defined, and also seen by users using non-HTML capable mail clients. See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Administration#Plaintext_invoice_templates">billing documentation</a> for details.',
+ 'section' => 'invoice_templates',
+ 'description' => 'Text template file for invoices. Used if no invoice_html template is defined, and also seen by users using non-HTML capable mail clients. See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Administration#Plaintext_invoice_templates">billing documentation</a> for details.',
'type' => 'textarea',
},
{
'key' => 'invoice_html',
- 'section' => 'invoicing',
- 'description' => 'HTML template for invoices. See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Administration#HTML_invoice_templates">billing documentation</a> for details.',
+ 'section' => 'invoice_templates',
+ 'description' => 'HTML template for invoices. See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Administration#HTML_invoice_templates">billing documentation</a> for details.',
'type' => 'textarea',
},
{
'key' => 'quotation_html',
- 'section' => '',
+ 'section' => 'quotations',
'description' => 'HTML template for quotations.',
'type' => 'textarea',
{
'key' => 'invoice_htmlnotes',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Notes section for HTML invoices. Defaults to the same data in invoice_latexnotes if not specified.',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'invoice_htmlfooter',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Footer for HTML invoices. Defaults to the same data in invoice_latexfooter if not specified.',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'invoice_htmlsummary',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Summary initial page for HTML invoices.',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'invoice_htmlreturnaddress',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Return address for HTML invoices. Defaults to the same data in invoice_latexreturnaddress if not specified.',
'type' => 'textarea',
'per_locale' => 1,
},
{
+ 'key' => 'invoice_htmlwatermark',
+ 'section' => 'invoice_templates',
+ 'description' => 'Watermark for HTML invoices. Appears in a semitransparent positioned DIV overlaid on the main invoice container.',
+ 'type' => 'textarea',
+ 'per_agent' => 1,
+ 'per_locale' => 1,
+ },
+
+ {
'key' => 'invoice_latex',
- 'section' => 'invoicing',
- 'description' => 'Optional LaTeX template for typeset PostScript invoices. See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Administration#Typeset_.28LaTeX.29_invoice_templates">billing documentation</a> for details.',
+ 'section' => 'invoice_templates',
+ 'description' => 'Optional LaTeX template for typeset PostScript invoices. See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Administration#Typeset_.28LaTeX.29_invoice_templates">billing documentation</a> for details.',
'type' => 'textarea',
},
{
'key' => 'quotation_latex',
- 'section' => '',
+ 'section' => 'quotations',
'description' => 'LaTeX template for typeset PostScript quotations.',
'type' => 'textarea',
},
{
'key' => 'invoice_latexnotes',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Notes section for LaTeX typeset PostScript invoices.',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'quotation_latexnotes',
- 'section' => '',
+ 'section' => 'quotations',
'description' => 'Notes section for LaTeX typeset PostScript quotations.',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'invoice_latexfooter',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Footer for LaTeX typeset PostScript invoices.',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'invoice_latexsummary',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Summary initial page for LaTeX typeset PostScript invoices.',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'invoice_latexcoupon',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Remittance coupon for LaTeX typeset PostScript invoices.',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'invoice_latexextracouponspace',
'section' => 'invoicing',
- 'description' => 'Optional LaTeX invoice textheight space to reserve for a tear off coupon. Include units. Default is 3.6cm',
+ 'description' => 'Optional LaTeX invoice textheight space to reserve for a tear off coupon. Include units. Default is 2.7 inches.',
'type' => 'text',
'per_agent' => 1,
'validate' => sub { shift =~
{
'key' => 'invoice_latexcouponfootsep',
'section' => 'invoicing',
- 'description' => 'Optional LaTeX invoice separation between tear off coupon and footer. Include units.',
+ 'description' => 'Optional LaTeX invoice separation between bottom of coupon address and footer. Include units. Default is 0.2 inches.',
'type' => 'text',
'per_agent' => 1,
'validate' => sub { shift =~
{
'key' => 'invoice_latexcouponamountenclosedsep',
'section' => 'invoicing',
- 'description' => 'Optional LaTeX invoice separation between total due and amount enclosed line. Include units.',
+ 'description' => 'Optional LaTeX invoice separation between total due and amount enclosed line. Include units. Default is 2.25 em.',
'type' => 'text',
'per_agent' => 1,
'validate' => sub { shift =~
{
'key' => 'invoice_latexcoupontoaddresssep',
'section' => 'invoicing',
- 'description' => 'Optional LaTeX invoice separation between invoice data and the to address (usually invoice_latexreturnaddress). Include units.',
+ 'description' => 'Optional LaTeX invoice separation between invoice data and the address (usually invoice_latexreturnaddress). Include units. Default is 1 inch.',
'type' => 'text',
'per_agent' => 1,
'validate' => sub { shift =~
{
'key' => 'invoice_latexreturnaddress',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Return address for LaTeX typeset PostScript invoices.',
'type' => 'textarea',
},
{
'key' => 'invoice_latexverticalreturnaddress',
- 'section' => 'invoicing',
- 'description' => 'Place the return address under the company logo rather than beside it.',
+ 'section' => 'deprecated',
+ 'description' => 'Deprecated. With old invoice_latex template, places the return address under the company logo rather than beside it.',
'type' => 'checkbox',
'per_agent' => 1,
},
{
'key' => 'invoice_latexsmallfooter',
- 'section' => 'invoicing',
+ 'section' => 'invoice_templates',
'description' => 'Optional small footer for multi-page LaTeX typeset PostScript invoices.',
'type' => 'textarea',
'per_agent' => 1,
},
{
+ 'key' => 'invoice_latexwatermark',
+ 'section' => 'invocie_templates',
+ 'description' => 'Watermark for LaTeX invoices. See "texdoc background" for information on what this can contain. The content itself should be enclosed in braces, optionally followed by a comma and any formatting options.',
+ 'type' => 'textarea',
+ 'per_agent' => 1,
+ 'per_locale' => 1,
+ },
+
+ {
'key' => 'invoice_email_pdf',
- 'section' => 'invoicing',
- 'description' => 'Send PDF invoice as an attachment to emailed invoices. By default, includes the plain text invoice as the email body, unless invoice_email_pdf_note is set.',
+ 'section' => 'invoice_email',
+ 'description' => 'Send PDF invoice as an attachment to emailed invoices. By default, includes the HTML invoice as the email body, unless invoice_email_pdf_note is set.',
+ 'type' => 'checkbox'
+ },
+
+ {
+ 'key' => 'quotation_email_pdf',
+ 'section' => 'quotations',
+ 'description' => 'Send PDF quotations as an attachment to emailed quotations. By default, includes the HTML quotation as the email body, unless quotation_email_pdf_note is set.',
'type' => 'checkbox'
},
{
+ 'key' => 'invoice_email_pdf_msgnum',
+ 'section' => 'invoice_email',
+ 'description' => 'Message template to send as the text and HTML part of PDF invoices. If not selected, a text and HTML version of the invoice will be sent.',
+ %msg_template_options,
+ },
+
+ {
'key' => 'invoice_email_pdf_note',
- 'section' => 'invoicing',
- 'description' => 'If defined, this text will replace the default plain text invoice as the body of emailed PDF invoices.',
+ 'section' => 'invoice_email',
+ 'description' => 'If defined, this text will replace the default HTML invoice as the body of emailed PDF invoices.',
+ 'type' => 'textarea'
+ },
+
+ {
+ 'key' => 'quotation_email_pdf_note',
+ 'section' => 'quotations',
+ 'description' => 'If defined, this text will replace the default HTML quotation as the body of emailed PDF quotations.',
'type' => 'textarea'
},
{
'key' => 'invoice_print_pdf',
- 'section' => 'invoicing',
+ 'section' => 'printing',
'description' => 'For all invoice print operations, store postal invoices for download in PDF format rather than printing them directly.',
'type' => 'checkbox',
},
{
'key' => 'invoice_print_pdf-spoolagent',
- 'section' => 'invoicing',
+ 'section' => 'printing',
'description' => 'Store postal invoices PDF downloads in per-agent spools.',
'type' => 'checkbox',
},
+ {
+ 'key' => 'invoice_print_pdf-duplex',
+ 'section' => 'printing',
+ 'description' => 'Insert blank pages so that spooled invoices are each an even number of pages. Use this for double-sided printing.',
+ 'type' => 'checkbox',
+ },
+
{
'key' => 'invoice_default_terms',
'section' => 'invoicing',
'description' => 'Optional default invoice term, used to calculate a due date printed on invoices.',
'type' => 'select',
- 'select_enum' => [ '', 'Payable upon receipt', 'Net 0', 'Net 3', 'Net 9', 'Net 10', 'Net 15', 'Net 18', 'Net 20', 'Net 21', 'Net 30', 'Net 45', 'Net 60', 'Net 90' ],
+ 'per_agent' => 1,
+ 'select_enum' => \@invoice_terms,
},
{
'key' => 'invoice_show_prior_due_date',
- 'section' => 'invoicing',
+ 'section' => 'invoice_balances',
'description' => 'Show previous invoice due dates when showing prior balances. Default is to show invoice date.',
'type' => 'checkbox',
},
{
'key' => 'invoice_include_aging',
- 'section' => 'invoicing',
+ 'section' => 'invoice_balances',
'description' => 'Show an aging line after the prior balance section. Only valid when invoice_sections is enabled.',
'type' => 'checkbox',
},
{
- 'key' => 'invoice_sections_by_location',
+ 'key' => 'invoice_sections_method',
'section' => 'invoicing',
- 'description' => 'Divide invoice into sections according to service location. Currently, this overrides sectioning by package category.',
- 'type' => 'checkbox',
- 'per_agent' => 1,
+ 'description' => 'How to group line items on multi-section invoices.',
+ 'type' => 'select',
+ 'select_enum' => [ qw(category location) ],
+ },
+
+ {
+ 'key' => 'summary_subtotals_method',
+ 'section' => 'invoicing',
+ 'description' => 'How to group line items when calculating summary subtotals. By default, it will be the same method used for grouping invoice sections.',
+ 'type' => 'select',
+ 'select_enum' => [ qw(category location) ],
},
#quotations seem broken-ish with sections ATM?
# 'per_agent' => 1,
#},
+ {
+ 'key' => 'usage_class_summary',
+ 'section' => 'telephony',
+ 'description' => 'On invoices, summarize total usage by usage class in a separate section',
+ 'type' => 'checkbox',
+ },
+
{
'key' => 'usage_class_as_a_section',
- 'section' => 'invoicing',
- 'description' => 'Split usage into sections and label according to usage class name when enabled. Only valid when invoice_sections is enabled.',
+ 'section' => 'telephony',
+ 'description' => 'On invoices, split usage into sections and label according to usage class name when enabled. Only valid when invoice_sections is enabled.',
'type' => 'checkbox',
},
{
'key' => 'phone_usage_class_summary',
- 'section' => 'invoicing',
- 'description' => 'Summarize usage per DID by usage class and display all CDRs together regardless of usage class. Only valid when svc_phone_sections is enabled.',
+ 'section' => 'telephony',
+ 'description' => 'On invoices, summarize usage per DID by usage class and display all CDRs together regardless of usage class. Only valid when svc_phone_sections is enabled.',
'type' => 'checkbox',
},
{
'key' => 'svc_phone_sections',
- 'section' => 'invoicing',
- 'description' => 'Create a section for each svc_phone when enabled. Only valid when invoice_sections is enabled.',
+ 'section' => 'telephony',
+ 'description' => 'On invoices, create a section for each svc_phone when enabled. Only valid when invoice_sections is enabled.',
'type' => 'checkbox',
},
{
'key' => 'separate_usage',
- 'section' => 'invoicing',
- 'description' => 'Split the rated call usage into a separate line from the recurring charges.',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'invoice_send_receipts',
- 'section' => 'deprecated',
- 'description' => '<b>DEPRECATED</b>, this used to send an invoice copy on payments and credits. See the payment_receipt_email and XXXX instead.',
+ 'section' => 'telephony',
+ 'description' => 'On invoices, split the rated call usage into a separate line from the recurring charges.',
'type' => 'checkbox',
},
},
{
+ 'key' => 'payment_receipt_statement_mode',
+ 'section' => 'notification',
+ 'description' => 'Automatic payments will cause a post-payment statement to be sent to the customer. Select the invoice mode to use for this statement. If unspecified, it will use the "_statement" versions of invoice configuration settings, and have the notice name "Statement".',
+ %invoice_mode_options,
+ },
+
+ {
'key' => 'payment_receipt_msgnum',
'section' => 'notification',
- 'description' => 'Template to use for payment receipts.',
+ 'description' => 'Template to use for manual payment receipts.',
%msg_template_options,
},
},
{
- 'key' => 'payment_receipt_email',
- 'section' => 'deprecated',
- 'description' => 'Template file for payment receipts. Payment receipts are sent to the customer email invoice destination(s) when a payment is received.',
- 'type' => [qw( checkbox textarea )],
- },
-
- {
'key' => 'payment_receipt-trigger',
'section' => 'notification',
'description' => 'When payment receipts are triggered. Defaults to when payment is made.',
},
{
+ 'key' => 'refund_receipt_msgnum',
+ 'section' => 'notification',
+ 'description' => 'Template to use for manual refund receipts.',
+ %msg_template_options,
+ },
+
+ {
'key' => 'trigger_export_insert_on_payment',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => 'Enable exports on payment application.',
'type' => 'checkbox',
},
{
'key' => 'lpr',
- 'section' => 'required',
+ 'section' => 'printing',
'description' => 'Print command for paper invoices, for example `lpr -h\'',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'lpr-postscript_prefix',
- 'section' => 'billing',
+ 'section' => 'printing',
'description' => 'Raw printer commands prepended to the beginning of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
'type' => 'text',
},
{
'key' => 'lpr-postscript_suffix',
- 'section' => 'billing',
+ 'section' => 'printing',
'description' => 'Raw printer commands added to the end of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
'type' => 'text',
},
{
- 'key' => 'money_char',
- 'section' => '',
- 'description' => 'Currency symbol - defaults to `$\'',
+ 'key' => 'papersize',
+ 'section' => 'printing',
+ 'description' => 'Invoice paper size. Default is "letter" (U.S. standard). The LaTeX template must be configured to match this size.',
+ 'type' => 'select',
+ 'select_enum' => [ qw(letter a4) ],
+ },
+
+ {
+ 'key' => 'money_char',
+ 'section' => 'localization',
+ 'description' => 'Currency symbol - defaults to `$\'',
'type' => 'text',
},
{
'key' => 'passwordmax',
'section' => 'password',
- 'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
+ 'description' => 'Maximum password length (default 12) (don\'t set this over 12 if you need to import or export crypt() passwords)',
+ 'type' => 'text',
+ },
+
+ {
+ 'key' => 'sip_passwordmin',
+ 'section' => 'telephony',
+ 'description' => 'Minimum SIP password length (default 6)',
+ 'type' => 'text',
+ },
+
+ {
+ 'key' => 'sip_passwordmax',
+ 'section' => 'telephony',
+ 'description' => 'Maximum SIP password length (default 80)',
'type' => 'text',
},
+
{
'key' => 'password-noampersand',
'section' => 'password',
{
'key' => 'referraldefault',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Default referral, specified by refnum',
'type' => 'select-sub',
'options_sub' => sub { require FS::Record;
},
},
-# {
-# 'key' => 'registries',
-# 'section' => 'required',
-# 'description' => 'Directory which contains domain registry information. Each registry is a directory.',
-# },
-
{
- 'key' => 'report_template',
- 'section' => 'deprecated',
- 'description' => 'Deprecated template file for reports.',
- 'type' => 'textarea',
+ 'key' => 'maxsearchrecordsperpage',
+ 'section' => 'reporting',
+ 'description' => 'If set, number of search records to return per page.',
+ 'type' => 'text',
},
{
- 'key' => 'maxsearchrecordsperpage',
- 'section' => 'UI',
- 'description' => 'If set, number of search records to return per page.',
+ 'key' => 'cust_main-packages-num_per_page',
+ 'section' => 'packages',
+ 'description' => 'Number of packages to display per page on customer view (default 10).',
'type' => 'text',
},
{
'key' => 'disable_maxselect',
- 'section' => 'UI',
+ 'section' => 'reporting',
'description' => 'Prevent changing the number of records per page.',
'type' => 'checkbox',
},
{
'key' => 'session-start',
- 'section' => 'session',
- 'description' => 'If defined, the command which is executed on the Freeside machine when a session begins. The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
+ 'section' => 'deprecated',
+ 'description' => 'Used to define the command which is executed on the Freeside machine when a session begins. The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
'type' => 'text',
},
{
'key' => 'session-stop',
- 'section' => 'session',
- 'description' => 'If defined, the command which is executed on the Freeside machine when a session ends. The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
+ 'section' => 'deprecated',
+ 'description' => 'Used to define the command which is executed on the Freeside machine when a session ends. The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
'type' => 'text',
},
{
'key' => 'showpasswords',
- 'section' => 'UI',
+ 'section' => 'password',
'description' => 'Display unencrypted user passwords in the backend (employee) web interface',
'type' => 'checkbox',
},
{
'key' => 'report-showpasswords',
- 'section' => 'UI',
+ 'section' => 'password',
'description' => 'This is a terrible idea. Do not enable it. STRONGLY NOT RECOMMENDED. Enables display of passwords on services reports.',
'type' => 'checkbox',
},
{
'key' => 'signupurl',
- 'section' => 'UI',
- 'description' => 'if you are using customer-to-customer referrals, and you enter the URL of your <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Self-Service_Installation">signup server CGI</a>, the customer view screen will display a customized link to the signup server with the appropriate customer as referral',
+ 'section' => 'signup',
+ 'description' => 'if you are using customer-to-customer referrals, and you enter the URL of your <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Self-Service_Installation">signup server CGI</a>, the customer view screen will display a customized link to self-signup with the appropriate customer as referral',
'type' => 'text',
},
{
'key' => 'smtpmachine',
- 'section' => 'required',
+ 'section' => 'important',
'description' => 'SMTP relay for Freeside\'s outgoing mail',
'type' => 'text',
},
{
'key' => 'smtp-username',
- 'section' => '',
+ 'section' => 'notification',
'description' => 'Optional SMTP username for Freeside\'s outgoing mail',
'type' => 'text',
},
{
'key' => 'smtp-password',
- 'section' => '',
+ 'section' => 'notification',
'description' => 'Optional SMTP password for Freeside\'s outgoing mail',
'type' => 'text',
},
{
'key' => 'smtp-encryption',
- 'section' => '',
+ 'section' => 'notification',
'description' => 'Optional SMTP encryption method. The STARTTLS methods require smtp-username and smtp-password to be set.',
'type' => 'select',
'select_hash' => [ '25' => 'None (port 25)',
{
'key' => 'statedefault',
- 'section' => 'UI',
+ 'section' => 'localization',
'description' => 'Default state or province (if not supplied, the default is `CA\')',
'type' => 'text',
},
{
- 'key' => 'unsuspendauto',
- 'section' => 'billing',
- 'description' => 'Enables the automatic unsuspension of suspended packages when a customer\'s balance due changes from positive to zero or negative as the result of a payment or credit',
- 'type' => 'checkbox',
+ 'key' => 'unsuspend_balance',
+ 'section' => 'suspension',
+ 'description' => 'Enables the automatic unsuspension of suspended packages when a customer\'s balance due is at or below the specified amount after a payment or credit',
+ 'type' => 'select',
+ 'select_enum' => [
+ '', 'Zero', 'Latest invoice charges', 'Charges not past due'
+ ],
},
{
'key' => 'unsuspend-always_adjust_next_bill_date',
- 'section' => 'billing',
+ 'section' => 'suspension',
'description' => 'Global override that causes unsuspensions to always adjust the next bill date under any circumstances. This is now controlled on a per-package bases - probably best not to use this option unless you are a legacy installation that requires this behaviour.',
'type' => 'checkbox',
},
},
{
- 'key' => 'safe-part_bill_event',
- 'section' => 'UI',
- 'description' => 'Validates invoice event expressions against a preset list. Useful for webdemos, annoying to powerusers.',
+ 'key' => 'google_maps_api_key',
+ 'section' => 'addresses',
+ 'description' => 'API key for google maps. This must be set for map and directions links to work. See <a href="https://developers.google.com/maps/documentation/javascript/get-api-key" target="_top">Getting a Google Maps API Key</a>',
+ 'type' => 'text',
+ },
+
+ {
+ 'key' => 'company_physical_address',
+ 'section' => 'addresses',
+ 'description' => 'Your physical company address, for use in supplying google map directions, defaults to company_address',
+ 'type' => 'textarea',
+ 'per_agent' => 1,
+ },
+
+ {
+ 'key' => 'show_ship_company',
+ 'section' => 'addresses',
+ 'description' => 'Turns on display/collection of a "service company name" field for customers.',
'type' => 'checkbox',
},
{
'key' => 'show_ss',
- 'section' => 'UI',
+ 'section' => 'e-checks',
'description' => 'Turns on display/collection of social security numbers in the web interface. Sometimes required by electronic check (ACH) processors.',
'type' => 'checkbox',
},
{
'key' => 'unmask_ss',
- 'section' => 'UI',
+ 'section' => 'e-checks',
'description' => "Don't mask social security numbers in the web interface.",
'type' => 'checkbox',
},
{
'key' => 'show_stateid',
- 'section' => 'UI',
+ 'section' => 'e-checks',
'description' => "Turns on display/collection of driver's license/state issued id numbers in the web interface. Sometimes required by electronic check (ACH) processors.",
'type' => 'checkbox',
},
{
'key' => 'national_id-country',
- 'section' => 'UI',
+ 'section' => 'localization',
'description' => 'Track a national identification number, for specific countries.',
'type' => 'select',
'select_enum' => [ '', 'MY' ],
{
'key' => 'show_bankstate',
- 'section' => 'UI',
+ 'section' => 'e-checks',
'description' => "Turns on display/collection of state for bank accounts in the web interface. Sometimes required by electronic check (ACH) processors.",
'type' => 'checkbox',
},
{
'key' => 'agent_defaultpkg',
- 'section' => 'UI',
+ 'section' => 'packages',
'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
'type' => 'checkbox',
},
{
'key' => 'queue_dangerous_controls',
- 'section' => 'UI',
+ 'section' => 'development',
'description' => 'Enable queue modification controls on account pages and for new jobs. Unless you are a developer working on new export code, you should probably leave this off to avoid causing provisioning problems.',
'type' => 'checkbox',
},
{
'key' => 'locale',
- 'section' => 'UI',
+ 'section' => 'localization',
'description' => 'Default locale',
'type' => 'select-sub',
'options_sub' => sub {
{
'key' => 'signup_server-payby',
- 'section' => 'self-service',
- 'description' => 'Acceptable payment types for the signup server',
+ 'section' => 'signup',
+ 'description' => 'Acceptable payment types for self-signup',
'type' => 'selectmultiple',
- 'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB PREPAY PPAL BILL COMP) ],
+ 'select_enum' => [ qw(CARD DCRD CHEK DCHK PREPAY PPAL ) ], # BILL COMP) ],
},
{
{
'key' => 'default_agentnum',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Default agent for the backoffice',
'type' => 'select-agent',
},
{
'key' => 'signup_server-default_agentnum',
- 'section' => 'self-service',
- 'description' => 'Default agent for the signup server',
+ 'section' => 'signup',
+ 'description' => 'Default agent for self-signup',
'type' => 'select-agent',
},
{
'key' => 'signup_server-default_refnum',
- 'section' => 'self-service',
- 'description' => 'Default advertising source for the signup server',
+ 'section' => 'signup',
+ 'description' => 'Default advertising source for self-signup',
'type' => 'select-sub',
'options_sub' => sub { require FS::Record;
require FS::part_referral;
{
'key' => 'signup_server-default_pkgpart',
- 'section' => 'self-service',
- 'description' => 'Default package for the signup server',
+ 'section' => 'signup',
+ 'description' => 'Default package for self-signup',
'type' => 'select-part_pkg',
},
{
'key' => 'signup_server-default_svcpart',
- 'section' => 'self-service',
- 'description' => 'Default service definition for the signup server - only necessary for services that trigger special provisioning widgets (such as DID provisioning or domain selection).',
+ 'section' => 'signup',
+ 'description' => 'Default service definition for self-signup - only necessary for services that trigger special provisioning widgets (such as DID provisioning or domain selection).',
'type' => 'select-part_svc',
},
{
'key' => 'signup_server-default_domsvc',
- 'section' => 'self-service',
- 'description' => 'If specified, the default domain svcpart for signup (useful when domain is set to selectable choice).',
+ 'section' => 'signup',
+ 'description' => 'If specified, the default domain svcpart for self-signup (useful when domain is set to selectable choice).',
'type' => 'text',
},
{
'key' => 'signup_server-mac_addr_svcparts',
- 'section' => 'self-service',
+ 'section' => 'signup',
'description' => 'Service definitions which can receive mac addresses (current mapped to username for svc_acct).',
'type' => 'select-part_svc',
'multiple' => 1,
{
'key' => 'signup_server-nomadix',
- 'section' => 'self-service',
+ 'section' => 'deprecated',
'description' => 'Signup page Nomadix integration',
'type' => 'checkbox',
},
{
'key' => 'signup_server-service',
- 'section' => 'self-service',
- 'description' => 'Service for the signup server - "Account (svc_acct)" is the default setting, or "Phone number (svc_phone)" for ITSP signup',
+ 'section' => 'signup',
+ 'description' => 'Service for the self-signup - "Account (svc_acct)" is the default setting, or "Phone number (svc_phone)" for ITSP signup',
'type' => 'select',
'select_hash' => [
'svc_acct' => 'Account (svc_acct)',
'svc_phone' => 'Phone number (svc_phone)',
'svc_pbx' => 'PBX (svc_pbx)',
+ 'none' => 'None - package only',
],
},
{
'key' => 'signup_server-prepaid-template-custnum',
- 'section' => 'self-service',
- 'description' => 'When the signup server is used with prepaid cards and customer info is not required for signup, the contact/address info will be copied from this customer, if specified',
+ 'section' => 'signup',
+ 'description' => 'When self-signup is used with prepaid cards and customer info is not required for signup, the contact/address info will be copied from this customer, if specified',
'type' => 'text',
},
{
'key' => 'signup_server-terms_of_service',
- 'section' => 'self-service',
- 'description' => 'Terms of Service for the signup server. May contain HTML.',
+ 'section' => 'signup',
+ 'description' => 'Terms of Service for self-signup. May contain HTML.',
'type' => 'textarea',
'per_agent' => 1,
},
{
'key' => 'show-msgcat-codes',
- 'section' => 'UI',
+ 'section' => 'development',
'description' => 'Show msgcat codes in error messages. Turn this option on before reporting errors to the mailing list.',
'type' => 'checkbox',
},
{
'key' => 'signup_server-realtime',
- 'section' => 'self-service',
- 'description' => 'Run billing for signup server signups immediately, and do not provision accounts which subsequently have a balance.',
+ 'section' => 'signup',
+ 'description' => 'Run billing for self-signups immediately, and do not provision accounts which subsequently have a balance.',
'type' => 'checkbox',
},
{
'key' => 'signup_server-classnum2',
- 'section' => 'self-service',
+ 'section' => 'signup',
'description' => 'Package Class for first optional purchase',
'type' => 'select-pkg_class',
},
{
'key' => 'signup_server-classnum3',
- 'section' => 'self-service',
+ 'section' => 'signup',
'description' => 'Package Class for second optional purchase',
'type' => 'select-pkg_class',
},
{
'key' => 'signup_server-third_party_as_card',
- 'section' => 'self-service',
+ 'section' => 'signup',
'description' => 'Allow customer payment type to be set to CARD even when using third-party credit card billing.',
'type' => 'checkbox',
},
{
'key' => 'selfservice-xmlrpc',
- 'section' => 'self-service',
+ 'section' => 'API',
'description' => 'Run a standalone self-service XML-RPC server on the backend (on port 8080).',
'type' => 'checkbox',
},
},
{
- 'key' => 'declinetemplate',
- 'section' => 'deprecated',
- 'description' => 'Template file for credit card and electronic check decline emails.',
- 'type' => 'textarea',
- },
-
- {
'key' => 'emaildecline',
'section' => 'notification',
'description' => 'Enable emailing of credit card and electronic check decline notices.',
{
'key' => 'cancel_msgnum',
- 'section' => 'notification',
+ 'section' => 'cancellation',
'description' => 'Template to use for cancellation emails.',
%msg_template_options,
},
{
- 'key' => 'cancelmessage',
- 'section' => 'deprecated',
- 'description' => 'Template file for cancellation emails.',
- 'type' => 'textarea',
- },
-
- {
- 'key' => 'cancelsubject',
- 'section' => 'deprecated',
- 'description' => 'Subject line for cancellation emails.',
- 'type' => 'text',
- },
-
- {
'key' => 'emailcancel',
- 'section' => 'notification',
+ 'section' => 'cancellation',
'description' => 'Enable emailing of cancellation notices. Make sure to select the template in the cancel_msgnum option.',
'type' => 'checkbox',
'per_agent' => 1,
{
'key' => 'bill_usage_on_cancel',
- 'section' => 'billing',
+ 'section' => 'cancellation',
'description' => 'Enable automatic generation of an invoice for usage when a package is cancelled. Not all packages can do this. Usage data must already be available.',
'type' => 'checkbox',
},
{
'key' => 'require_cardname',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
'type' => 'checkbox',
},
{
'key' => 'enable_taxclasses',
- 'section' => 'billing',
+ 'section' => 'taxation',
'description' => 'Enable per-package tax classes',
'type' => 'checkbox',
},
{
'key' => 'require_taxclasses',
- 'section' => 'billing',
+ 'section' => 'taxation',
'description' => 'Require a taxclass to be entered for every package',
'type' => 'checkbox',
},
{
- 'key' => 'enable_taxproducts',
- 'section' => 'billing',
- 'description' => 'Enable per-package mapping to vendor tax data from CCH or elsewhere.',
- 'type' => 'checkbox',
+ 'key' => 'tax_data_vendor',
+ 'section' => 'taxation',
+ 'description' => 'Tax data vendor you are using.',
+ 'type' => 'select',
+ 'select_enum' => [ '', 'cch', 'billsoft', 'avalara', 'suretax' ],
},
{
'key' => 'taxdatadirectdownload',
- 'section' => 'billing', #well
- 'description' => 'Enable downloading tax data directly from the vendor site. at least three lines: URL, username, and password.j',
+ 'section' => 'taxation',
+ 'description' => 'Enable downloading tax data directly from CCH. at least three lines: URL, username, and password.j',
'type' => 'textarea',
},
{
'key' => 'ignore_incalculable_taxes',
- 'section' => 'billing',
+ 'section' => 'taxation',
'description' => 'Prefer to invoice without tax over not billing at all',
'type' => 'checkbox',
},
{
- 'key' => 'welcome_msgnum',
- 'section' => 'notification',
- 'description' => 'Template to use for welcome messages when a svc_acct record is created.',
- %msg_template_options,
- },
-
- {
- 'key' => 'svc_acct_welcome_exclude',
- 'section' => 'notification',
- 'description' => 'A list of svc_acct services for which no welcome email is to be sent.',
- 'type' => 'select-part_svc',
- 'multiple' => 1,
+ 'key' => 'billsoft-company_code',
+ 'section' => 'taxation',
+ 'description' => 'Billsoft tax service company code (3 letters)',
+ 'type' => 'text',
},
{
- 'key' => 'welcome_email',
- 'section' => 'deprecated',
- 'description' => 'Template file for welcome email. Welcome emails are sent to the customer email invoice destination(s) each time a svc_acct record is created.',
+ 'key' => 'avalara-taxconfig',
+ 'section' => 'taxation',
+ 'description' => 'Avalara tax service configuration. Four lines: company code, account number, license key, test mode (1 to enable).',
'type' => 'textarea',
- 'per_agent' => 1,
},
{
- 'key' => 'welcome_email-from',
- 'section' => 'deprecated',
- 'description' => 'From: address header for welcome email',
+ 'key' => 'suretax-hostname',
+ 'section' => 'taxation',
+ 'description' => 'SureTax server name; defaults to the test server.',
'type' => 'text',
- 'per_agent' => 1,
},
{
- 'key' => 'welcome_email-subject',
- 'section' => 'deprecated',
- 'description' => 'Subject: header for welcome email',
+ 'key' => 'suretax-client_number',
+ 'section' => 'taxation',
+ 'description' => 'SureTax tax service client ID.',
'type' => 'text',
- 'per_agent' => 1,
},
-
{
- 'key' => 'welcome_email-mimetype',
- 'section' => 'deprecated',
- 'description' => 'MIME type for welcome email',
- 'type' => 'select',
- 'select_enum' => [ 'text/plain', 'text/html' ],
+ 'key' => 'suretax-validation_key',
+ 'section' => 'taxation',
+ 'description' => 'SureTax validation key (UUID).',
+ 'type' => 'text',
+ },
+ {
+ 'key' => 'suretax-business_unit',
+ 'section' => 'taxation',
+ 'description' => 'SureTax client business unit name; optional.',
+ 'type' => 'text',
'per_agent' => 1,
},
-
{
- 'key' => 'welcome_letter',
- 'section' => '',
- 'description' => 'Optional LaTex template file for a printed welcome letter. A welcome letter is printed the first time a cust_pkg record is created. See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation and the billing documentation for details on the template substitution language. A variable exists for each fieldname in the customer record (<code>$first, $last, etc</code>). The following additional variables are available<ul><li><code>$payby</code> - a friendler represenation of the field<li><code>$payinfo</code> - the masked payment information<li><code>$expdate</code> - the time at which the payment method expires (a UNIX timestamp)<li><code>$returnaddress</code> - the invoice return address for this customer\'s agent</ul>',
- 'type' => 'textarea',
+ 'key' => 'suretax-regulatory_code',
+ 'section' => 'taxation',
+ 'description' => 'SureTax client regulatory status.',
+ 'type' => 'select',
+ 'select_enum' => [ '', 'ILEC', 'IXC', 'CLEC', 'VOIP', 'ISP', 'Wireless' ],
+ 'per_agent' => 1,
},
-# {
-# 'key' => 'warning_msgnum',
-# 'section' => 'notification',
-# 'description' => 'Template to use for warning messages, sent to the customer email invoice destination(s) when a svc_acct record has its usage drop below a threshold.',
-# %msg_template_options,
-# },
{
- 'key' => 'warning_email',
- 'section' => 'notification',
- 'description' => 'Template file for warning email. Warning emails are sent to the customer email invoice destination(s) each time a svc_acct record has its usage drop below a threshold or 0. See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitution language. The following variables are available<ul><li><code>$username</code> <li><code>$password</code> <li><code>$first</code> <li><code>$last</code> <li><code>$pkg</code> <li><code>$column</code> <li><code>$amount</code> <li><code>$threshold</code></ul>',
- 'type' => 'textarea',
+ 'key' => 'welcome_msgnum',
+ 'section' => 'deprecated',
+ 'description' => 'Deprecated; use a billing event instead. Used to be the template to use for welcome messages when a svc_acct record is created.',
+ %msg_template_options,
},
-
+
{
- 'key' => 'warning_email-from',
- 'section' => 'notification',
- 'description' => 'From: address header for warning email',
- 'type' => 'text',
+ 'key' => 'svc_acct_welcome_exclude',
+ 'section' => 'deprecated',
+ 'description' => 'Deprecated; use a billing event instead. A list of svc_acct services for which no welcome email is to be sent.',
+ 'type' => 'select-part_svc',
+ 'multiple' => 1,
},
{
- 'key' => 'warning_email-cc',
+ 'key' => 'welcome_letter',
'section' => 'notification',
- 'description' => 'Additional recipient(s) (comma separated) for warning email when remaining usage reaches zero.',
- 'type' => 'text',
+ 'description' => 'Optional LaTex template file for a printed welcome letter. A welcome letter is printed the first time a cust_pkg record is created. See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation and the billing documentation for details on the template substitution language. A variable exists for each fieldname in the customer record (<code>$first, $last, etc</code>). The following additional variables are available<ul><li><code>$payby</code> - a friendler represenation of the field<li><code>$payinfo</code> - the masked payment information<li><code>$expdate</code> - the time at which the payment method expires (a UNIX timestamp)<li><code>$returnaddress</code> - the invoice return address for this customer\'s agent</ul>',
+ 'type' => 'textarea',
},
{
- 'key' => 'warning_email-subject',
- 'section' => 'notification',
- 'description' => 'Subject: header for warning email',
- 'type' => 'text',
- },
-
- {
- 'key' => 'warning_email-mimetype',
+ 'key' => 'threshold_warning_msgnum',
'section' => 'notification',
- 'description' => 'MIME type for warning email',
- 'type' => 'select',
- 'select_enum' => [ 'text/plain', 'text/html' ],
+ 'description' => 'Template to use for warning messages sent to the customer email invoice destination(s) when a svc_acct record has its usage drop below a threshold. Extra substitutions available: $column, $amount, $threshold',
+ %msg_template_options,
},
{
'key' => 'payby',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => 'Available payment types.',
'type' => 'selectmultiple',
- 'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD PPAL COMP) ],
+ 'select_enum' => [ qw(CARD DCRD CHEK DCHK) ], #BILL CASH WEST MCRD MCHK PPAL) ],
+ },
+
+ {
+ 'key' => 'banned_pay-pad',
+ 'section' => 'credit_cards',
+ 'description' => 'Padding for encrypted storage of banned credit card hashes. If you already have new-style SHA512 entries in the banned_pay table, do not change as this will invalidate the old entries.',
+ 'type' => 'text',
},
{
'key' => 'payby-default',
- 'section' => 'UI',
- 'description' => 'Default payment type. HIDE disables display of billing information and sets customers to BILL.',
+ 'section' => 'deprecated',
+ 'description' => 'Deprecated; in 4.x there is no longer the concept of a single "payment type". Used to indicate the default payment type. HIDE disables display of billing information and sets customers to BILL.',
'type' => 'select',
- 'select_enum' => [ '', qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD PPAL COMP HIDE) ],
+ 'select_enum' => [ '', qw(CARD DCRD CHEK DCHK BILL CASH WEST MCRD PPAL COMP HIDE) ],
},
{
'key' => 'require_cash_deposit_info',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => 'When recording cash payments, display bank deposit information fields.',
'type' => 'checkbox',
},
{
- 'key' => 'paymentforcedtobatch',
- 'section' => 'deprecated',
- 'description' => 'See batch-enable_payby and realtime-disable_payby. Used to (for CHEK): Cause per customer payment entry to be forced to a batch processor rather than performed realtime.',
- 'type' => 'checkbox',
- },
-
- {
'key' => 'svc_acct-notes',
'section' => 'deprecated',
'description' => 'Extra HTML to be displayed on the Account View screen.',
{
'key' => 'radius-password',
- 'section' => '',
+ 'section' => 'RADIUS',
'description' => 'RADIUS attribute for plain-text passwords.',
'type' => 'select',
'select_enum' => [ 'Password', 'User-Password', 'Cleartext-Password' ],
{
'key' => 'radius-ip',
- 'section' => '',
+ 'section' => 'RADIUS',
'description' => 'RADIUS attribute for IP addresses.',
'type' => 'select',
'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
#http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
{
'key' => 'radius-chillispot-max',
- 'section' => '',
+ 'section' => 'RADIUS',
'description' => 'Enable ChilliSpot (and CoovaChilli) Max attributes, specifically ChilliSpot-Max-{Input,Output,Total}-{Octets,Gigawords}.',
'type' => 'checkbox',
},
{
+ 'key' => 'radius-canopy',
+ 'section' => 'RADIUS',
+ 'description' => 'Enable RADIUS attributes for Cambium (formerly Motorola) Canopy (Motorola-Canopy-Gateway).',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'svc_broadband-radius',
- 'section' => '',
+ 'section' => 'RADIUS',
'description' => 'Enable RADIUS groups for broadband services.',
'type' => 'checkbox',
},
{
'key' => 'svc_acct-alldomains',
- 'section' => '',
+ 'section' => 'services',
'description' => 'Allow accounts to select any domain in the database. Normally accounts can only select from the domain set in the service definition and those purchased by the customer.',
'type' => 'checkbox',
},
{
'key' => 'dump-localdest',
- 'section' => '',
+ 'section' => 'backup',
'description' => 'Destination for local database dumps (full path)',
'type' => 'text',
},
{
'key' => 'dump-scpdest',
- 'section' => '',
+ 'section' => 'backup',
'description' => 'Destination for scp database dumps: user@host:/path',
'type' => 'text',
},
{
'key' => 'dump-pgpid',
- 'section' => '',
+ 'section' => 'backup',
'description' => "Optional PGP public key user or key id for database dumps. The public key should exist on the freeside user's public keyring, and the gpg binary and GnuPG perl module should be installed.",
'type' => 'text',
},
{
- 'key' => 'users-allow_comp',
- 'section' => 'deprecated',
- 'description' => '<b>DEPRECATED</b>, enable the <i>Complimentary customer</i> access right instead. Was: Usernames (Freeside users, created with <a href="../docs/man/bin/freeside-adduser.html">freeside-adduser</a>) which can create complimentary customers, one per line. If no usernames are entered, all users can create complimentary accounts.',
- 'type' => 'textarea',
- },
-
- {
'key' => 'credit_card-recurring_billing_flag',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'This controls when the system passes the "recurring_billing" flag on credit card transactions. If supported by your processor (and the Business::OnlinePayment processor module), passing the flag indicates this is a recurring transaction and may turn off the CVV requirement. ',
'type' => 'select',
'select_hash' => [
'actual_oncard' => 'Default/classic behavior: set the flag if a customer has actual previous charges on the card.',
- 'transaction_is_recur' => 'Set the flag if the transaction itself is recurring, irregardless of previous charges on the card.',
+ 'transaction_is_recur' => 'Set the flag if the transaction itself is recurring, regardless of previous charges on the card.',
],
},
{
'key' => 'credit_card-recurring_billing_acct_code',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'When the "recurring billing" flag is set, also set the "acct_code" to "rebill". Useful for reporting purposes with supported gateways (PlugNPay, others?)',
'type' => 'checkbox',
},
{
'key' => 'cvv-save',
- 'section' => 'billing',
- 'description' => 'Save CVV2 information after the initial transaction for the selected credit card types. Enabling this option may be in violation of your merchant agreement(s), so please check them carefully before enabling this option for any credit card types.',
+ 'section' => 'credit_cards',
+ 'description' => 'NOT RECOMMENDED. Saves CVV2 information after the initial transaction for the selected credit card types. Enabling this option is almost certainly in violation of your merchant agreement(s), so please check them carefully before enabling this option for any credit card types.',
'type' => 'selectmultiple',
'select_enum' => \@card_types,
},
{
+ 'key' => 'signup-require_cvv',
+ 'section' => 'credit_cards',
+ 'description' => 'Require CVV for credit card signup.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'backoffice-require_cvv',
+ 'section' => 'credit_cards',
+ 'description' => 'Require CVV for manual credit card entry.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'selfservice-onfile_require_cvv',
+ 'section' => 'credit_cards',
+ 'description' => 'Require CVV for on-file credit card during self-service payments.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'selfservice-require_cvv',
+ 'section' => 'credit_cards',
+ 'description' => 'Require CVV for credit card self-service payments, except for cards on-file.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'manual_process-single_invoice_amount',
+ 'section' => 'payments',
+ 'description' => 'When entering manual credit card and ACH payments, amount will not autofill if the customer has more than one open invoice',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'manual_process-pkgpart',
- 'section' => 'billing',
- 'description' => 'Package to add to each manual credit card and ACH payment entered by employees from the backend. Enabling this option may be in violation of your merchant agreement(s), so please check it(/them) carefully before enabling this option.',
+ 'section' => 'payments',
+ 'description' => 'Package to add to each manual credit card and ACH payment entered by employees from the backend. WARNING: Although recently permitted to US merchants in general, specific consumer protection laws may prohibit or restrict this practice in California, Colorado, Connecticut, Florda, Kansas, Maine, Massachusetts, New York, Oklahome, and Texas. Surcharging is also generally prohibited in most countries outside the US, AU and UK.',
'type' => 'select-part_pkg',
'per_agent' => 1,
},
{
'key' => 'manual_process-display',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => 'When using manual_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
'type' => 'select',
'select_hash' => [
{
'key' => 'manual_process-skip_first',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => "When using manual_process-pkgpart, omit the fee if it is the customer's first payment.",
'type' => 'checkbox',
},
{
+ 'key' => 'selfservice_immutable-package',
+ 'section' => 'self-service',
+ 'description' => 'Disable package changes in self-service interface.',
+ 'type' => 'checkbox',
+ 'per_agent' => 1,
+ },
+
+ {
+ 'key' => 'selfservice_hide-usage',
+ 'section' => 'self-service',
+ 'description' => 'Hide usage data in self-service interface.',
+ 'type' => 'checkbox',
+ 'per_agent' => 1,
+ },
+
+ {
'key' => 'selfservice_process-pkgpart',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => 'Package to add to each manual credit card and ACH payment entered by the customer themselves in the self-service interface. Enabling this option may be in violation of your merchant agreement(s), so please check it(/them) carefully before enabling this option.',
'type' => 'select-part_pkg',
'per_agent' => 1,
{
'key' => 'selfservice_process-display',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => 'When using selfservice_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
'type' => 'select',
'select_hash' => [
{
'key' => 'selfservice_process-skip_first',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => "When using selfservice_process-pkgpart, omit the fee if it is the customer's first payment.",
'type' => 'checkbox',
},
{
'key' => 'allow_negative_charges',
- 'section' => 'billing',
+ 'section' => 'deprecated',
'description' => 'Allow negative charges. Normally not used unless importing data from a legacy system that requires this.',
'type' => 'checkbox',
},
{
'key' => 'auto_unset_catchall',
- 'section' => '',
+ 'section' => 'cancellation',
'description' => 'When canceling a svc_acct that is the email catchall for one or more svc_domains, automatically set their catchall fields to null. If this option is not set, the attempt will simply fail.',
'type' => 'checkbox',
},
{
'key' => 'cust_pkg-change_svcpart',
- 'section' => '',
+ 'section' => 'packages',
'description' => "When changing packages, move services even if svcparts don't match between old and new pacakge definitions.",
'type' => 'checkbox',
},
{
'key' => 'cust_pkg-change_pkgpart-bill_now',
- 'section' => '',
+ 'section' => 'RADIUS',
'description' => "When changing packages, bill the new package immediately. Useful for prepaid situations with RADIUS where an Expiration attribute based on the package must be present at all times.",
'type' => 'checkbox',
},
{
'key' => 'svc_www-enable_subdomains',
- 'section' => '',
+ 'section' => 'services',
'description' => 'Enable selection of specific subdomains for virtual host creation.',
'type' => 'checkbox',
},
{
'key' => 'svc_www-usersvc_svcpart',
- 'section' => '',
+ 'section' => 'services',
'description' => 'Allowable service definition svcparts for virtual hosts, one per line.',
'type' => 'select-part_svc',
'multiple' => 1,
'description' => 'If enabled, specifies the type of verification required for self-service password resets.',
'type' => 'select',
'select_hash' => [ '' => 'Password reset disabled',
- 'paymask,amount,zip' => 'Verify with credit card (or bank account) last 4 digits, payment amount and zip code',
+ 'email' => 'Click on a link in email',
+ 'paymask,amount,zip' => 'Click on a link in email, and also verify with credit card (or bank account) last 4 digits, payment amount and zip code. Note: Do not use if you have multi-customer contacts, as they will be unable to reset their passwords.',
],
},
},
{
+ 'key' => 'selfservice-password_change_oldpass',
+ 'section' => 'self-service',
+ 'description' => 'Require old password to be entered again for password changes (in addition to being logged in), at the API level.',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'selfservice-hide_invoices-taxclass',
'section' => 'self-service',
'description' => 'Hide invoices with only this package tax class from self-service and supress sending (emailing, printing, faxing) them. Typically set to something like "Previous balance" and used when importing legacy invoices into legacy_cust_bill.',
},
'option_sub' => sub { require FS::Record;
require FS::agent_type;
- my $agent = FS::Record::qsearchs(
+ my $agent_type = FS::Record::qsearchs(
'agent_type', { 'typenum'=>shift }
);
$agent_type ? $agent_type->atype : '';
'section' => 'self-service',
'description' => 'Suspend reason when customers suspend their own packages. Set to nothing to disallow self-suspension.',
'type' => 'select-sub',
+ #false laziness w/api_credit_reason
'options_sub' => sub { require FS::Record;
require FS::reason;
my $type = qsearchs('reason_type',
{
'key' => 'card_refund-days',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'After a payment, the number of days a refund link will be available for that payment. Defaults to 120.',
'type' => 'text',
},
{
'key' => 'agent-showpasswords',
- 'section' => '',
+ 'section' => 'deprecated',
'description' => 'Display unencrypted user passwords in the agent (reseller) interface',
'type' => 'checkbox',
},
{
'key' => 'global_unique-phonenum',
- 'section' => '',
+ 'section' => 'telephony',
'description' => 'Global phone number uniqueness control: none (usual setting - check countrycode+phonenumun uniqueness per exports), or countrycode+phonenum (all countrycode+phonenum pairs are globally unique, regardless of exports). disabled turns off duplicate checking completely and is STRONGLY NOT RECOMMENDED unless you REALLY need to turn this off.',
'type' => 'select',
'select_enum' => [ 'none', 'countrycode+phonenum', 'disabled' ],
{
'key' => 'global_unique-pbx_title',
- 'section' => '',
+ 'section' => 'telephony',
'description' => 'Global phone number uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
'type' => 'select',
'select_enum' => [ 'enabled', 'disabled' ],
{
'key' => 'global_unique-pbx_id',
- 'section' => '',
+ 'section' => 'telephony',
'description' => 'Global PBX id uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
'type' => 'select',
'select_enum' => [ 'enabled', 'disabled' ],
{
'key' => 'ticket_system',
'section' => 'ticketing',
- 'description' => 'Ticketing system integration. <b>RT_Internal</b> uses the built-in RT ticketing system (see the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:RT_Installation">integrated ticketing installation instructions</a>). <b>RT_External</b> accesses an external RT installation in a separate database (local or remote).',
+ 'description' => 'Ticketing system integration. <b>RT_Internal</b> uses the built-in RT ticketing system (see the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:RT_Installation">integrated ticketing installation instructions</a>). <b>RT_External</b> accesses an external RT installation in a separate database (local or remote).',
'type' => 'select',
#'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
'select_enum' => [ '', qw(RT_Internal RT_External) ],
{
'key' => 'network_monitoring_system',
'section' => 'network_monitoring',
- 'description' => 'Networking monitoring system (NMS) integration. <b>Torrus_Internal</b> uses the built-in Torrus ticketing system (see the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Torrus_Installation">integrated networking monitoring system installation instructions</a>).',
+ 'description' => 'Networking monitoring system (NMS) integration. <b>Torrus_Internal</b> uses the built-in Torrus network monitoring system (see the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Torrus_Installation">installation instructions</a>).',
'type' => 'select',
'select_enum' => [ '', qw(Torrus_Internal) ],
},
},
{
+ 'key' => 'pingd-interval',
+ 'section' => 'network_monitoring',
+ 'description' => 'Run ping scans of broadband services at this interval.',
+ 'type' => 'select',
+ 'select_hash' => [ '' => '',
+ 60 => '1 min',
+ 300 => '5 min',
+ 600 => '10 min',
+ 1800 => '30 min',
+ 3600 => '1 hour',
+ 14400 => '4 hours',
+ 28800 => '8 hours',
+ 86400 => '1 day',
+ ],
+ },
+
+ {
'key' => 'ticket_system-default_queueid',
'section' => 'ticketing',
'description' => 'Default queue used when creating new customer tickets.',
}
},
},
+
{
'key' => 'ticket_system-force_default_queueid',
'section' => 'ticketing',
'description' => 'Disallow queue selection when creating new tickets from customer view.',
'type' => 'checkbox',
},
+
{
'key' => 'ticket_system-selfservice_queueid',
'section' => 'ticketing',
},
{
- 'key' => 'ticket_system-escalation',
- 'section' => 'ticketing',
- 'description' => 'Enable priority escalation of tickets as part of daily batch processing.',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'ticket_system-rt_external_datasrc',
- 'section' => 'ticketing',
+ 'key' => 'ticket_system-appointment-queueid',
+ 'section' => 'appointments',
+ 'description' => 'Ticketing queue to use for appointments.',
+ #false laziness w/above
+ 'type' => 'select-sub',
+ 'options_sub' => sub {
+ my $conf = new FS::Conf;
+ if ( $conf->config('ticket_system') ) {
+ eval "use FS::TicketSystem;";
+ die $@ if $@;
+ FS::TicketSystem->queues();
+ } else {
+ ();
+ }
+ },
+ 'option_sub' => sub {
+ my $conf = new FS::Conf;
+ if ( $conf->config('ticket_system') ) {
+ eval "use FS::TicketSystem;";
+ die $@ if $@;
+ FS::TicketSystem->queue(shift);
+ } else {
+ '';
+ }
+ },
+ },
+
+ {
+ 'key' => 'ticket_system-appointment-custom_field',
+ 'section' => 'appointments',
+ 'description' => 'Ticketing custom field to use as an appointment classification.',
+ 'type' => 'text',
+ },
+
+ {
+ 'key' => 'ticket_system-escalation',
+ 'section' => 'ticketing',
+ 'description' => 'Enable priority escalation of tickets as part of daily batch processing.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'ticket_system-rt_external_datasrc',
+ 'section' => 'ticketing',
'description' => 'With external RT integration, the DBI data source for the external RT installation, for example, <code>DBI:Pg:user=rt_user;password=rt_word;host=rt.example.com;dbname=rt</code>',
'type' => 'text',
{
'key' => 'company_name',
- 'section' => 'required',
+ 'section' => 'important',
'description' => 'Your company name',
'type' => 'text',
'per_agent' => 1, #XXX just FS/FS/ClientAPI/Signup.pm
{
'key' => 'company_address',
- 'section' => 'required',
+ 'section' => 'important',
'description' => 'Your company address',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'company_phonenum',
- 'section' => 'notification',
+ 'section' => 'important',
'description' => 'Your company phone number',
'type' => 'text',
'per_agent' => 1,
},
{
- 'key' => 'echeck-void',
- 'section' => 'deprecated',
- 'description' => '<B>DEPRECATED</B>, now controlled by ACLs. Used to enable local-only voiding of echeck payments in addition to refunds against the payment gateway',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'cc-void',
- 'section' => 'deprecated',
- 'description' => '<B>DEPRECATED</B>, now controlled by ACLs. Used to enable local-only voiding of credit card payments in addition to refunds against the payment gateway',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'unvoid',
- 'section' => 'deprecated',
- 'description' => '<B>DEPRECATED</B>, now controlled by ACLs. Used to enable unvoiding of voided payments',
- 'type' => 'checkbox',
- },
-
- {
'key' => 'address1-search',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'Enable the ability to search the address1 field from the quick customer search. Not recommended in most cases as it tends to bring up too many search results - use explicit address searching from the advanced customer search instead.',
'type' => 'checkbox',
},
{
'key' => 'address2-search',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'Enable a "Unit" search box which searches the second address field. Useful for multi-tenant applications. See also: cust_main-require_address2',
'type' => 'checkbox',
},
{
'key' => 'cust_main-require_address2',
- 'section' => 'UI',
- 'description' => 'Second address field is required (on service address only, if billing and service addresses differ). Also enables "Unit" labeling of address2 on customer view and edit pages. Useful for multi-tenant applications. See also: address2-search',
+ 'section' => 'addresses',
+ 'description' => 'Second address field is required. Also enables "Unit" labeling of address2 on customer view and edit pages. Useful for multi-tenant applications. See also: address2-search', # service address only part not working in the modern world, see #41184 (on service address only, if billing and service addresses differ)
'type' => 'checkbox',
},
{
'key' => 'agent-ship_address',
- 'section' => '',
+ 'section' => 'addresses',
'description' => "Use the agent's master service address as the service address (only ship_address2 can be entered, if blank on the master address). Useful for multi-tenant applications.",
'type' => 'checkbox',
'per_agent' => 1,
},
- { 'key' => 'referral_credit',
- 'section' => 'deprecated',
- 'description' => "Used to enable one-time referral credits in the amount of one month <i>referred</i> customer's recurring fee (irregardless of frequency). Replace with a billing event on appropriate packages.",
- 'type' => 'checkbox',
- },
-
{ 'key' => 'selfservice_server-cache_module',
'section' => 'self-service',
'description' => 'Module used to store self-service session information. All modules handle any number of self-service servers. Cache::SharedMemoryCache is appropriate for a single database / single Freeside server. Cache::FileCache is useful for multiple databases on a single server, or when IPC::ShareLite is not available (i.e. FreeBSD).', # _Database stores session information in the database and is appropriate for multiple Freeside servers, but may be slower.',
{
'key' => 'hylafax',
- 'section' => 'billing',
+ 'section' => 'deprecated',
'description' => 'Options for a HylaFAX server to enable the FAX invoice destination. They should be in the form of a space separated list of arguments to the Fax::Hylafax::Client::sendfax subroutine. You probably shouldn\'t override things like \'docfile\'. *Note* Only supported when using typeset invoices (see the invoice_latex configuration option).',
'type' => [qw( checkbox textarea )],
},
{
'key' => 'cust_bill-ftpformat',
- 'section' => 'invoicing',
+ 'section' => 'print_services',
'description' => 'Enable FTP of raw invoice data - format.',
'type' => 'select',
'options' => [ spool_formats() ],
{
'key' => 'cust_bill-ftpserver',
- 'section' => 'invoicing',
+ 'section' => 'print_services',
'description' => 'Enable FTP of raw invoice data - server.',
'type' => 'text',
},
{
'key' => 'cust_bill-ftpusername',
- 'section' => 'invoicing',
+ 'section' => 'print_services',
'description' => 'Enable FTP of raw invoice data - server.',
'type' => 'text',
},
{
'key' => 'cust_bill-ftppassword',
- 'section' => 'invoicing',
+ 'section' => 'print_services',
'description' => 'Enable FTP of raw invoice data - server.',
'type' => 'text',
},
{
'key' => 'cust_bill-ftpdir',
- 'section' => 'invoicing',
+ 'section' => 'print_services',
'description' => 'Enable FTP of raw invoice data - server.',
'type' => 'text',
},
{
'key' => 'cust_bill-spoolformat',
- 'section' => 'invoicing',
+ 'section' => 'print_services',
'description' => 'Enable spooling of raw invoice data - format.',
'type' => 'select',
'options' => [ spool_formats() ],
{
'key' => 'cust_bill-spoolagent',
- 'section' => 'invoicing',
+ 'section' => 'print_services',
'description' => 'Enable per-agent spooling of raw invoice data.',
'type' => 'checkbox',
},
{
'key' => 'bridgestone-batch_counter',
- 'section' => '',
+ 'section' => 'print_services',
'description' => 'Batch counter for spool files. Increments every time a spool file is uploaded.',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'bridgestone-prefix',
- 'section' => '',
+ 'section' => 'print_services',
'description' => 'Agent identifier for uploading to BABT printing service.',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'bridgestone-confirm_template',
- 'section' => '',
+ 'section' => 'print_services',
'description' => 'Confirmation email template for uploading to BABT service. Text::Template format, with variables "$zipfile" (name of the zipped file), "$seq" (sequence number), "$prefix" (user ID string), and "$rows" (number of records in the file). Should include Subject: and To: headers, separated from the rest of the message by a blank line.',
# this could use a true message template, but it's hard to see how that
# would make the world a better place
{
'key' => 'ics-confirm_template',
- 'section' => '',
+ 'section' => 'print_services',
'description' => 'Confirmation email template for uploading to ICS invoice printing. Text::Template format, with variables "%count" and "%sum".',
'type' => 'textarea',
'per_agent' => 1,
{
'key' => 'svc_acct-usage_suspend',
- 'section' => 'billing',
+ 'section' => 'suspension',
'description' => 'Suspends the package an account belongs to when svc_acct.seconds or a bytecount is decremented to 0 or below (accounts with an empty seconds and up|down|totalbytes value are ignored). Typically used in conjunction with prepaid packages and freeside-sqlradius-radacctd.',
'type' => 'checkbox',
},
{
'key' => 'svc_acct-usage_unsuspend',
- 'section' => 'billing',
+ 'section' => 'suspension',
'description' => 'Unuspends the package an account belongs to when svc_acct.seconds or a bytecount is incremented from 0 or below to a positive value (accounts with an empty seconds and up|down|totalbytes value are ignored). Typically used in conjunction with prepaid packages and freeside-sqlradius-radacctd.',
'type' => 'checkbox',
},
{
'key' => 'svc_acct-usage_threshold',
- 'section' => 'billing',
+ 'section' => 'notification',
'description' => 'The threshold (expressed as percentage) of acct.seconds or acct.up|down|totalbytes at which a warning message is sent to a service holder. Typically used in conjunction with prepaid packages and freeside-sqlradius-radacctd.',
'type' => 'text',
},
{
'key' => 'overlimit_groups',
- 'section' => '',
+ 'section' => 'suspension',
'description' => 'RADIUS group(s) to assign to svc_acct which has exceeded its bandwidth or time limit.',
'type' => 'select-sub',
'per_agent' => 1,
{
'key' => 'cust-fields',
- 'section' => 'UI',
+ 'section' => 'reporting',
'description' => 'Which customer fields to display on reports by default',
'type' => 'select',
'select_hash' => [ FS::ConfDefaults->cust_fields_avail() ],
{
'key' => 'cust_location-label_prefix',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'Optional "site ID" to show in the location label',
'type' => 'select',
'select_hash' => [ '' => '',
- 'CoStAg' => 'CoStAgXXXXX (country, state, agent name, locationnum)',
+ 'CoStAg' => 'CoStAgXXXXX (country, state, agent name, locationnum)',
+ '_location' => 'Manually defined per location',
],
},
{
'key' => 'cust_pkg-display_times',
- 'section' => 'UI',
+ 'section' => 'packages',
'description' => 'Display full timestamps (not just dates) for customer packages. Useful if you are doing real-time things like hourly prepaid.',
'type' => 'checkbox',
},
{
- 'key' => 'cust_pkg-always_show_location',
- 'section' => 'UI',
- 'description' => "Always display package locations, even when they're all the default service address.",
+ 'key' => 'cust_pkg-group_by_location',
+ 'section' => 'packages',
+ 'description' => "Group packages by location.",
'type' => 'checkbox',
},
{
- 'key' => 'cust_pkg-group_by_location',
- 'section' => 'UI',
- 'description' => "Group packages by location.",
- 'type' => 'checkbox',
+ 'key' => 'cust_pkg-large_pkg_size',
+ 'section' => 'scalability',
+ 'description' => "In customer view, summarize packages with more than this many services. Set to zero to never summarize packages.",
+ 'type' => 'text',
},
{
- 'key' => 'cust_pkg-show_fcc_voice_grade_equivalent',
- 'section' => 'UI',
- 'description' => "Show fields on package definitions for FCC Form 477 classification",
+ 'key' => 'cust_pkg-hide_discontinued-part_svc',
+ 'section' => 'packages',
+ 'description' => "In customer view, hide provisioned services which are no longer available in the package definition. Not normally used except for very specific situations as it hides still-provisioned services.",
'type' => 'checkbox',
},
{
- 'key' => 'cust_pkg-large_pkg_size',
- 'section' => 'UI',
- 'description' => "In customer view, summarize packages with more than this many services. Set to zero to never summarize packages.",
- 'type' => 'text',
+ 'key' => 'part_pkg-show_fcc_options',
+ 'section' => 'packages',
+ 'description' => "Show fields on package definitions for FCC Form 477 classification",
+ 'type' => 'checkbox',
},
{
{
'key' => 'echeck-country',
- 'section' => 'billing',
+ 'section' => 'e-checks',
'description' => 'Format electronic check information for the specified country.',
'type' => 'select',
'select_hash' => [ 'US' => 'United States',
{
'key' => 'voip-cdr_email',
'section' => 'telephony',
- 'description' => 'Include the call details on emailed invoices (and HTML invoices viewed in the backend), even if the customer is configured for not printing them on the invoices.',
+ 'description' => 'Include the call details inline on emailed invoices (and HTML invoices viewed in the backend), even if the customer is configured for not printing them on the invoices. Useful for including these details in electronic delivery but omitting them when printing.',
'type' => 'checkbox',
},
{
- 'key' => 'voip-cust_email_csv_cdr',
+ 'key' => 'voip-cdr_email_attach',
'section' => 'telephony',
- 'description' => 'Enable the per-customer option for including CDR information as a CSV attachment on emailed invoices.',
- 'type' => 'checkbox',
+ 'description' => 'Enable the per-customer option for including CDR information as an attachment on emailed invoices.',
+ 'type' => 'select',
+ 'select_hash' => [ '' => 'Disabled',
+ 'csv' => 'Text (CSV) attachment',
+ 'zip' => 'Zip attachment',
+ ],
},
{
'key' => 'cgp_rule-domain_templates',
- 'section' => '',
+ 'section' => 'services',
'description' => 'Communigate Pro rule templates for domains, one per line, "svcnum Name"',
'type' => 'textarea',
},
{
'key' => 'svc_forward-no_srcsvc',
- 'section' => '',
+ 'section' => 'services',
'description' => "Don't allow forwards from existing accounts, only arbitrary addresses. Useful when exporting to systems such as Communigate Pro which treat forwards in this fashion.",
'type' => 'checkbox',
},
{
'key' => 'svc_forward-arbitrary_dst',
- 'section' => '',
+ 'section' => 'services',
'description' => "Allow forwards to point to arbitrary strings that don't necessarily look like email addresses. Only used when using forwards for weird, non-email things.",
'type' => 'checkbox',
},
{
'key' => 'tax-ship_address',
- 'section' => 'billing',
+ 'section' => 'taxation',
'description' => 'By default, tax calculations are done based on the billing address. Enable this switch to calculate tax based on the shipping address instead.',
'type' => 'checkbox',
}
,
{
'key' => 'tax-pkg_address',
- 'section' => 'billing',
+ 'section' => 'taxation',
'description' => 'By default, tax calculations are done based on the billing address. Enable this switch to calculate tax based on the package address instead (when present).',
'type' => 'checkbox',
},
},
{
+ 'key' => 'invoice-all_pkg_addresses',
+ 'section' => 'invoicing',
+ 'description' => 'Show all package addresses on invoices, even the default.',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'invoice-unitprice',
'section' => 'invoicing',
'description' => 'Enable unit pricing on invoices and quantities on packages.',
{
'key' => 'postal_invoice-fee_pkgpart',
- 'section' => 'billing',
+ 'section' => 'invoicing',
'description' => 'This allows selection of a package to insert on invoices for customers with postal invoices selected.',
'type' => 'select-part_pkg',
'per_agent' => 1,
{
'key' => 'postal_invoice-recurring_only',
- 'section' => 'billing',
+ 'section' => 'invoicing',
'description' => 'The postal invoice fee is omitted on invoices without recurring charges when this is set.',
'type' => 'checkbox',
},
{
'key' => 'batch-enable_payby',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Enable batch processing for the specified payment types.',
'type' => 'selectmultiple',
'select_enum' => [qw( CARD CHEK )],
{
'key' => 'realtime-disable_payby',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => 'Disable realtime processing for the specified payment types.',
'type' => 'selectmultiple',
'select_enum' => [qw( CARD CHEK )],
{
'key' => 'batch-default_format',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Default format for batches.',
'type' => 'select',
'select_enum' => [ 'NACHA', 'csv-td_canada_trust-merchant_pc_batch',
'csv-chase_canada-E-xactBatch', 'BoM', 'PAP',
- 'paymentech', 'ach-spiritone', 'RBC'
+ 'paymentech', 'ach-spiritone', 'RBC', 'CIBC',
]
},
{ 'key' => 'batch-gateway-CARD',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Business::BatchPayment gateway for credit card batches.',
%batch_gateway_options,
},
{ 'key' => 'batch-gateway-CHEK',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Business::BatchPayment gateway for check batches.',
%batch_gateway_options,
},
{
'key' => 'batch-reconsider',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Allow imported batch results to change the status of payments from previous imports. Enable this only if your gateway is known to send both positive and negative results for the same batch.',
'type' => 'checkbox',
},
{
'key' => 'batch-auto_resolve_days',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Automatically resolve payment batches this many days after they were first downloaded.',
'type' => 'text',
},
{
'key' => 'batch-auto_resolve_status',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'When automatically resolving payment batches, take this action for payments of unknown status.',
'type' => 'select',
'select_enum' => [ 'approve', 'decline' ],
},
+ # replaces batch-errors_to (sent email on error)
{
- 'key' => 'batch-errors_to',
- 'section' => 'billing',
- 'description' => 'Email errors when processing batches to this address. If unspecified, batch processing will stop immediately on error.',
- 'type' => 'text',
+ 'key' => 'batch-errors_not_fatal',
+ 'section' => 'payment_batching',
+ 'description' => 'If checked, when importing batches from a gateway, item errors will be recorded in the system log without aborting processing. If unchecked, batch processing will fail on error.',
+ 'type' => 'checkbox',
},
#lists could be auto-generated from pay_batch info
{
'key' => 'batch-fixed_format-CARD',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Fixed (unchangeable) format for credit card batches.',
'type' => 'select',
'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP' ,
{
'key' => 'batch-fixed_format-CHEK',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Fixed (unchangeable) format for electronic check batches.',
'type' => 'select',
'select_enum' => [ 'NACHA', 'csv-td_canada_trust-merchant_pc_batch', 'BoM',
'PAP', 'paymentech', 'ach-spiritone', 'RBC',
- 'td_eft1464', 'eft_canada'
+ 'td_eft1464', 'eft_canada', 'CIBC'
]
},
{
'key' => 'batch-increment_expiration',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Increment expiration date years in batches until cards are current. Make sure this is acceptable to your batching provider before enabling.',
'type' => 'checkbox'
},
{
'key' => 'batchconfig-BoM',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Configuration for Bank of Montreal batching, seven lines: 1. Origin ID, 2. Datacenter, 3. Typecode, 4. Short name, 5. Long name, 6. Bank, 7. Bank account',
'type' => 'textarea',
},
+{
+ 'key' => 'batchconfig-CIBC',
+ 'section' => 'payment_batching',
+ 'description' => 'Configuration for Canadian Imperial Bank of Commerce, six lines: 1. Origin ID, 2. Datacenter, 3. Typecode, 4. Short name, 5. Bank, 6. Bank account',
+ 'type' => 'textarea',
+ },
+
{
'key' => 'batchconfig-PAP',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Configuration for PAP batching, seven lines: 1. Origin ID, 2. Datacenter, 3. Typecode, 4. Short name, 5. Long name, 6. Bank, 7. Bank account',
'type' => 'textarea',
},
{
'key' => 'batchconfig-csv-chase_canada-E-xactBatch',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Gateway ID for Chase Canada E-xact batching',
'type' => 'text',
},
{
'key' => 'batchconfig-paymentech',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Configuration for Chase Paymentech batching, six lines: 1. BIN, 2. Terminal ID, 3. Merchant ID, 4. Username, 5. Password (for batch uploads), 6. Flag to send recurring indicator.',
'type' => 'textarea',
},
{
'key' => 'batchconfig-RBC',
- 'section' => 'billing',
- 'description' => 'Configuration for Royal Bank of Canada PDS batching, four lines: 1. Client number, 2. Short name, 3. Long name, 4. Transaction code.',
+ 'section' => 'payment_batching',
+ 'description' => 'Configuration for Royal Bank of Canada PDS batching, five lines: 1. Client number, 2. Short name, 3. Long name, 4. Transaction code 5. (optional) set to TEST to turn on test mode.',
+ 'type' => 'textarea',
+ },
+
+ {
+ 'key' => 'batchconfig-RBC-login',
+ 'section' => 'payment_batching',
+ 'description' => 'FTPS login for uploading Royal Bank of Canada batches. Two lines: 1. username, 2. password. If not supplied, batches can still be created but not automatically uploaded.',
'type' => 'textarea',
},
{
'key' => 'batchconfig-td_eft1464',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Configuration for TD Bank EFT1464 batching, seven lines: 1. Originator ID, 2. Datacenter Code, 3. Short name, 4. Long name, 5. Returned payment branch number, 6. Returned payment account, 7. Transaction code.',
'type' => 'textarea',
},
{
'key' => 'batchconfig-eft_canada',
- 'section' => 'billing',
- 'description' => 'Configuration for EFT Canada batching, four lines: 1. SFTP username, 2. SFTP password, 3. Transaction code, 4. Number of days to delay process date. If you are using separate per-agent batches (batch-spoolagent), you must set this option separately for each agent, as the global setting will be ignored.',
+ 'section' => 'payment_batching',
+ 'description' => 'Configuration for EFT Canada batching, five lines: 1. SFTP username, 2. SFTP password, 3. Business transaction code, 4. Personal transaction code, 5. Number of days to delay process date. If you are using separate per-agent batches (batch-spoolagent), you must set this option separately for each agent, as the global setting will be ignored.',
'type' => 'textarea',
'per_agent' => 1,
},
{
'key' => 'batchconfig-nacha-destination',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Configuration for NACHA batching, Destination (9 digit transit routing number).',
'type' => 'text',
},
{
'key' => 'batchconfig-nacha-destination_name',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Configuration for NACHA batching, Destination (Bank Name, up to 23 characters).',
'type' => 'text',
},
{
'key' => 'batchconfig-nacha-origin',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Configuration for NACHA batching, Origin (your 10-digit company number, IRS tax ID recommended).',
'type' => 'text',
},
{
+ 'key' => 'batchconfig-nacha-origin_name',
+ 'section' => 'payment_batching',
+ 'description' => 'Configuration for NACHA batching, Origin name (defaults to company name, but sometimes bank name is needed instead.)',
+ 'type' => 'text',
+ },
+
+ {
'key' => 'batch-manual_approval',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Allow manual batch closure, which will approve all payments that do not yet have a status. This is not advised unless needed for specific payment processors that provide a report of rejected rather than approved payments.',
'type' => 'checkbox',
},
{
'key' => 'batch-spoolagent',
- 'section' => 'billing',
+ 'section' => 'payment_batching',
'description' => 'Store payment batches per-agent.',
'type' => 'checkbox',
},
{
'key' => 'cust_main-packages-years',
- 'section' => 'UI',
+ 'section' => 'packages',
'description' => 'Number of years to show old (cancelled and one-time charge) packages by default. Currently defaults to 2.',
'type' => 'text',
},
{
'key' => 'cust_main-use_comments',
- 'section' => 'UI',
+ 'section' => 'deprecated',
'description' => 'Display free form comments on the customer edit screen. Useful as a scratch pad.',
'type' => 'checkbox',
},
{
'key' => 'cust_main-disable_notes',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Disable new style customer notes - timestamped and user identified customer notes. Useful in tracking who did what.',
'type' => 'checkbox',
},
{
'key' => 'cust_main_note-display_times',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Display full timestamps (not just dates) for customer notes.',
'type' => 'checkbox',
},
{
+ 'key' => 'cust_main_note-require_class',
+ 'section' => 'customer_fields',
+ 'description' => 'Require customer note classes for customer notes',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'cust_main-ticket_statuses',
- 'section' => 'UI',
+ 'section' => 'ticketing',
'description' => 'Show tickets with these statuses on the customer view page.',
'type' => 'selectmultiple',
'select_enum' => [qw( new open stalled resolved rejected deleted )],
{
'key' => 'cust_main-max_tickets',
- 'section' => 'UI',
+ 'section' => 'ticketing',
'description' => 'Maximum number of tickets to show on the customer view page.',
'type' => 'text',
},
{
'key' => 'cust_main-enable_birthdate',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Enable tracking of a birth date with each customer record',
'type' => 'checkbox',
},
{
- 'key' => 'cust_main-enable_spouse_birthdate',
- 'section' => 'UI',
- 'description' => 'Enable tracking of a spouse birth date with each customer record',
+ 'key' => 'cust_main-enable_spouse',
+ 'section' => 'customer_fields',
+ 'description' => 'Enable tracking of a spouse\'s name and date of birth with each customer record',
'type' => 'checkbox',
},
{
'key' => 'cust_main-enable_anniversary_date',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Enable tracking of an anniversary date with each customer record',
'type' => 'checkbox',
},
{
'key' => 'cust_main-edit_calling_list_exempt',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Display the "calling_list_exempt" checkbox on customer edit.',
'type' => 'checkbox',
},
{
'key' => 'support-key',
- 'section' => '',
- 'description' => 'A support key enables access to commercial services delivered over the network, such as the payroll module, access to the internal ticket system, priority support and optional backups.',
+ 'section' => 'important',
+ 'description' => 'A support key enables access to <A HREF="http://freeside.biz/freeside/services.html#support">commercial services</A> delivered over the network, such as address normalization and invoice printing.',
+ 'type' => 'text',
+ },
+
+ {
+ 'key' => 'freesideinc-webservice-svcpart',
+ 'section' => 'development',
+ 'description' => 'Do not set this.',
'type' => 'text',
},
{
'key' => 'card-types',
- 'section' => 'billing',
+ 'section' => 'credit_cards',
'description' => 'Select one or more card types to enable only those card types. If no card types are selected, all card types are available.',
'type' => 'selectmultiple',
'select_enum' => \@card_types,
{
'key' => 'disable-fuzzy',
- 'section' => 'UI',
+ 'section' => 'scalability',
'description' => 'Disable fuzzy searching. Speeds up searching for large sites, but only shows exact matches.',
'type' => 'checkbox',
},
{
'key' => 'fuzzy-fuzziness',
- 'section' => 'UI',
+ 'section' => 'scalability',
'description' => 'Set the "fuzziness" of fuzzy searching (see the String::Approx manpage for details). Defaults to 10%',
'type' => 'text',
},
- {
- 'key' => 'enable_fuzzy_on_exact',
- 'section' => 'UI',
- 'description' => 'Enable approximate customer searching even when an exact match is found.',
- 'type' => 'checkbox',
- },
-
{ 'key' => 'pkg_referral',
- 'section' => '',
+ 'section' => 'packages',
'description' => 'Enable package-specific advertising sources.',
'type' => 'checkbox',
},
{ 'key' => 'pkg_referral-multiple',
- 'section' => '',
+ 'section' => 'packages',
'description' => 'In addition, allow multiple advertising sources to be associated with a single package.',
'type' => 'checkbox',
},
},
{
- 'key' => 'impending_recur_template',
- 'section' => 'deprecated',
- 'description' => 'Template file for alerts about looming first time recurrant billing. See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitition language. Also see packages with a <a href="../browse/part_pkg.cgi">flat price plan</a> The following variables are available<ul><li><code>$packages</code> allowing <code>$packages->[0]</code> thru <code>$packages->[n]</code> <li><code>$package</code> the first package, same as <code>$packages->[0]</code> <li><code>$recurdates</code> allowing <code>$recurdates->[0]</code> thru <code>$recurdates->[n]</code> <li><code>$recurdate</code> the first recurdate, same as <code>$recurdate->[0]</code> <li><code>$first</code> <li><code>$last</code></ul>',
-# <li><code>$payby</code> <li><code>$expdate</code> most likely only confuse
- 'type' => 'textarea',
- },
-
- {
'key' => 'logo.png',
- 'section' => 'UI', #'invoicing' ?
+ 'section' => 'important', #'invoicing' ?
'description' => 'Company logo for HTML invoices and the backoffice interface, in PNG format. Suggested size somewhere near 92x62.',
'type' => 'image',
'per_agent' => 1, #XXX just view/logo.cgi, which is for the global
{
'key' => 'logo.eps',
- 'section' => 'invoicing',
- 'description' => 'Company logo for printed and PDF invoices, in EPS format.',
+ 'section' => 'printing',
+ 'description' => 'Company logo for printed and PDF invoices and quotations, in EPS format.',
'type' => 'image',
'per_agent' => 1, #XXX as above, kinda
'per_locale' => 1,
'select_enum' => [ '1 hour', '2 hours', '4 hours', '8 hours', '1 day', '1 week', ],
},
- {
- 'key' => 'disable_setup_suspended_pkgs',
- 'section' => 'billing',
- 'description' => 'Disables charging of setup fees for suspended packages.',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'password-generated-allcaps',
- 'section' => 'password',
- 'description' => 'Causes passwords automatically generated to consist entirely of capital letters',
- 'type' => 'checkbox',
- },
+ # 3.x-only options for a more tolerant password policy
+# {
+# 'key' => 'password-generated-characters',
+# 'section' => 'password',
+# 'description' => 'Set of characters to use when generating random passwords. This must contain at least one lowercase letter, uppercase letter, digit, and punctuation mark.',
+# 'type' => 'textarea',
+# },
+#
+# {
+# 'key' => 'password-no_reuse',
+# 'section' => 'password',
+# 'description' => 'Minimum number of password changes before a password can be reused. By default, passwords can be reused without restriction.',
+# 'type' => 'text',
+# },
+#
{
'key' => 'datavolume-forcemegabytes',
'section' => 'UI',
{
'key' => 'disable_void_after',
- 'section' => 'billing',
+ 'section' => 'payments',
'description' => 'Number of seconds after which freeside won\'t attempt to VOID a payment first when performing a refund.',
'type' => 'text',
},
{
'key' => 'disable_line_item_date_ranges',
- 'section' => 'billing',
+ 'section' => 'invoicing',
'description' => 'Prevent freeside from automatically generating date ranges on invoice line items.',
'type' => 'checkbox',
},
{
'key' => 'cust_bill-line_item-date_style',
- 'section' => 'billing',
+ 'section' => 'invoicing',
'description' => 'Display format for line item date ranges on invoice line items.',
'type' => 'select',
'select_hash' => [ '' => 'STARTDATE-ENDDATE',
{
'key' => 'cust_bill-line_item-date_style-non_monthly',
- 'section' => 'billing',
+ 'section' => 'invoicing',
'description' => 'If set, override cust_bill-line_item-date_style for non-monthly charges.',
'type' => 'select',
'select_hash' => [ '' => 'Default',
{
'key' => 'cust_bill-line_item-date_description',
- 'section' => 'billing',
+ 'section' => 'invoicing',
'description' => 'Text to display for "DATE_DESC" when using cust_bill-line_item-date_style DATE_DESC MONTHNAME.',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'support_packages',
- 'section' => '',
+ 'section' => 'development',
'description' => 'A list of packages eligible for RT ticket time transfer, one pkgpart per line.', #this should really be a select multiple, or specified in the packages themselves...
'type' => 'select-part_pkg',
'multiple' => 1,
{
'key' => 'cust_main-require_phone',
- 'section' => '',
+ 'section' => 'customer_fields',
'description' => 'Require daytime or night phone for all customer records.',
'type' => 'checkbox',
'per_agent' => 1,
{
'key' => 'cust_main-require_invoicing_list_email',
- 'section' => '',
+ 'section' => 'customer_fields',
'description' => 'Email address field is required: require at least one invoicing email address for all customer records.',
'type' => 'checkbox',
'per_agent' => 1,
},
{
+ 'key' => 'cust_main-require_classnum',
+ 'section' => 'customer_fields',
+ 'description' => 'Customer class is required: require customer class for all customer records.',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'cust_main-check_unique',
- 'section' => '',
+ 'section' => 'customer_fields',
'description' => 'Warn before creating a customer record where these fields duplicate another customer.',
'type' => 'select',
'multiple' => 1,
{
'key' => 'svc_acct-display_paid_time_remaining',
- 'section' => '',
+ 'section' => 'services',
'description' => 'Show paid time remaining in addition to time remaining.',
'type' => 'checkbox',
},
{
'key' => 'cancel_credit_type',
- 'section' => 'billing',
+ 'section' => 'cancellation',
'description' => 'The group to use for new, automatically generated credit reasons resulting from cancellation.',
reason_type_options('R'),
},
{
'key' => 'suspend_credit_type',
- 'section' => 'billing',
+ 'section' => 'suspension',
'description' => 'The group to use for new, automatically generated credit reasons resulting from package suspension.',
reason_type_options('R'),
},
{
- 'key' => 'referral_credit_type',
- 'section' => 'deprecated',
- 'description' => 'Used to be the group to use for new, automatically generated credit reasons resulting from referrals. Now set in a package billing event for the referral.',
- reason_type_options('R'),
- },
-
- {
- 'key' => 'signup_credit_type',
- 'section' => 'billing', #self-service?
- 'description' => 'The group to use for new, automatically generated credit reasons resulting from signup and self-service declines.',
- reason_type_options('R'),
- },
-
- {
'key' => 'prepayment_discounts-credit_type',
'section' => 'billing',
'description' => 'Enables the offering of prepayment discounts and establishes the credit reason type.',
{
'key' => 'cust_main-agent_custid-format',
- 'section' => '',
+ 'section' => 'customer_number',
'description' => 'Enables searching of various formatted values in cust_main.agent_custid',
'type' => 'select',
'select_hash' => [
{
'key' => 'card_masking_method',
- 'section' => 'UI',
+ 'section' => 'credit_cards',
'description' => 'Digits to display when masking credit cards. Note that the first six digits are necessary to canonically identify the credit card type (Visa/MC, Amex, Discover, Maestro, etc.) in all cases. The first four digits can identify the most common credit card types in most cases (Visa/MC, Amex, and Discover). The first two digits can distinguish between Visa/MC and Amex. Note: You should manually remove stored paymasks if you change this value on an existing database, to avoid problems using stored cards.',
'type' => 'select',
'select_hash' => [
{
'key' => 'disable_previous_balance',
- 'section' => 'invoicing',
- 'description' => 'Disable inclusion of previous balance, payment, and credit lines on invoices.',
+ 'section' => 'invoice_balances',
+ 'description' => 'Show new charges only; do not list previous invoices, payments, or credits on the invoice.',
'type' => 'checkbox',
'per_agent' => 1,
},
{
'key' => 'previous_balance-exclude_from_total',
- 'section' => 'invoicing',
- 'description' => 'Do not include previous balance in the \'Total\' line. Only meaningful when invoice_sections is false. Optionally provide text to override the Total New Charges description',
- 'type' => [ qw(checkbox text) ],
+ 'section' => 'invoice_balances',
+ 'description' => 'Show separate totals for previous invoice balance and new charges. Only meaningful when invoice_sections is false.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'previous_balance-text',
+ 'section' => 'invoice_balances',
+ 'description' => 'Text for the label of the total previous balance, when it is shown separately. Defaults to "Previous Balance".',
+ 'type' => 'text',
+ 'per_locale' => 1,
+ },
+
+ {
+ 'key' => 'previous_balance-text-total_new_charges',
+ 'section' => 'invoice_balances',
+ 'description' => 'Text for the label of the total of new charges, when it is shown separately. If invoice_show_prior_due_date is enabled, the due date of current charges will be appended. Defaults to "Total New Charges".',
+ 'type' => 'text',
+ 'per_locale' => 1,
},
{
'key' => 'previous_balance-section',
- 'section' => 'invoicing',
+ 'section' => 'invoice_balances',
'description' => 'Show previous invoice balances in a separate invoice section. Does not require invoice_sections to be enabled.',
'type' => 'checkbox',
},
{
'key' => 'previous_balance-summary_only',
- 'section' => 'invoicing',
+ 'section' => 'invoice_balances',
'description' => 'Only show a single line summarizing the total previous balance rather than one line per invoice.',
'type' => 'checkbox',
},
{
'key' => 'previous_balance-show_credit',
- 'section' => 'invoicing',
+ 'section' => 'invoice_balances',
'description' => 'Show the customer\'s credit balance on invoices when applicable.',
'type' => 'checkbox',
},
{
'key' => 'previous_balance-show_on_statements',
- 'section' => 'invoicing',
+ 'section' => 'invoice_balances',
'description' => 'Show previous invoices on statements, without itemized charges.',
'type' => 'checkbox',
},
{
'key' => 'previous_balance-payments_since',
- 'section' => 'invoicing',
+ 'section' => 'invoice_balances',
'description' => 'Instead of showing payments (and credits) applied to the invoice, show those received since the previous invoice date.',
'type' => 'checkbox',
},
{
+ 'key' => 'previous_invoice_history',
+ 'section' => 'invoice_balances',
+ 'description' => 'Show a month-by-month history of the customer\'s '.
+ 'billing amounts. This requires template '.
+ 'modification and is currently not supported on the '.
+ 'stock template.',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'balance_due_below_line',
- 'section' => 'invoicing',
+ 'section' => 'invoice_balances',
'description' => 'Place the balance due message below a line. Only meaningful when when invoice_sections is false.',
'type' => 'checkbox',
},
{
'key' => 'always_show_tax',
- 'section' => 'invoicing',
+ 'section' => 'taxation',
'description' => 'Show a line for tax on the invoice even when the tax is zero. Optionally provide text for the tax name to show.',
'type' => [ qw(checkbox text) ],
},
{
'key' => 'address_standardize_method',
- 'section' => 'UI', #???
+ 'section' => 'addresses', #???
'description' => 'Method for standardizing customer addresses.',
'type' => 'select',
'select_hash' => [ '' => '',
+ 'uscensus' => 'U.S. Census Bureau',
'usps' => 'U.S. Postal Service',
- 'ezlocate' => 'EZLocate',
- 'tomtom' => 'TomTom',
+ 'melissa' => 'Melissa WebSmart',
+ 'freeside' => 'Freeside web service (support contract required)',
],
},
{
'key' => 'usps_webtools-userid',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'Production UserID for USPS web tools. Enables USPS address standardization. See the <a href="http://www.usps.com/webtools/">USPS website</a>, register and agree not to use the tools for batch purposes.',
'type' => 'text',
},
{
'key' => 'usps_webtools-password',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'Production password for USPS web tools. Enables USPS address standardization. See <a href="http://www.usps.com/webtools/">USPS website</a>, register and agree not to use the tools for batch purposes.',
'type' => 'text',
},
{
- 'key' => 'tomtom-userid',
- 'section' => 'UI',
- 'description' => 'TomTom geocoding service API key. See <a href="http://www.tomtom.com/">the TomTom website</a> to obtain a key. This is recommended for addresses in the United States only.',
- 'type' => 'text',
- },
-
- {
- 'key' => 'ezlocate-userid',
- 'section' => 'UI',
- 'description' => 'User ID for EZ-Locate service. See <a href="http://www.geocode.com/">the TomTom website</a> for access and pricing information.',
+ 'key' => 'melissa-userid',
+ 'section' => 'addresses', # it's really not...
+ 'description' => 'User ID for Melissa WebSmart service. See <a href="http://www.melissadata.com/">the Melissa website</a> for access and pricing.',
'type' => 'text',
},
{
- 'key' => 'ezlocate-password',
- 'section' => 'UI',
- 'description' => 'Password for EZ-Locate service.',
- 'type' => 'text'
+ 'key' => 'melissa-enable_geocoding',
+ 'section' => 'addresses',
+ 'description' => 'Use the Melissa service for census tract and coordinate lookups. Enable this only if your subscription includes geocoding access.',
+ 'type' => 'checkbox',
},
{
'key' => 'cust_main-auto_standardize_address',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'When using USPS web tools, automatically standardize the address without asking.',
'type' => 'checkbox',
},
{
'key' => 'cust_main-require_censustract',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'Customer is required to have a census tract. Useful for FCC form 477 reports. See also: cust_main-auto_standardize_address',
'type' => 'checkbox',
},
{
+ 'key' => 'cust_main-no_city_in_address',
+ 'section' => 'localization',
+ 'description' => 'Turn off City for billing & shipping addresses',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'census_year',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'The year to use in census tract lookups. NOTE: you need to select 2012 or 2013 for Year 2010 Census tract codes. A selection of 2011 provides Year 2000 Census tract codes. Use the freeside-censustract-update tool if exisitng customers need to be changed.',
'type' => 'select',
'select_enum' => [ qw( 2013 2012 2011 ) ],
{
'key' => 'tax_district_method',
- 'section' => 'UI',
+ 'section' => 'taxation',
'description' => 'The method to use to look up tax district codes.',
'type' => 'select',
#'select_hash' => [ FS::Misc::Geo::get_district_methods() ],
},
{
- 'key' => 'company_latitude',
- 'section' => 'UI',
- 'description' => 'Your company latitude (-90 through 90)',
+ 'key' => 'tax_district_taxname',
+ 'section' => 'taxation',
+ 'description' => 'The tax name to display on the invoice for district sales taxes. Defaults to "Tax".',
'type' => 'text',
},
{
- 'key' => 'company_longitude',
- 'section' => 'UI',
- 'description' => 'Your company longitude (-180 thru 180)',
+ 'key' => 'company_latitude',
+ 'section' => 'taxation',
+ 'description' => 'For Avalara taxation, your company latitude (-90 through 90)',
'type' => 'text',
},
{
- 'key' => 'geocode_module',
- 'section' => '',
- 'description' => 'Module to geocode (retrieve a latitude and longitude for) addresses',
- 'type' => 'select',
- 'select_enum' => [ 'Geo::Coder::Googlev3' ],
+ 'key' => 'company_longitude',
+ 'section' => 'taxation',
+ 'description' => 'For Avalara taxation, your company longitude (-180 thru 180)',
+ 'type' => 'text',
},
+ #if we can't change it from the default yet, what good is it to the end-user?
+ #{
+ # 'key' => 'geocode_module',
+ # 'section' => 'addresses',
+ # 'description' => 'Module to geocode (retrieve a latitude and longitude for) addresses',
+ # 'type' => 'select',
+ # 'select_enum' => [ 'Geo::Coder::Googlev3' ],
+ #},
+
{
'key' => 'geocode-require_nw_coordinates',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'Require latitude and longitude in the North Western quadrant, e.g. for North American co-ordinates, etc.',
'type' => 'checkbox',
},
{
'key' => 'disable_acl_changes',
- 'section' => '',
+ 'section' => 'development',
'description' => 'Disable all ACL changes, for demos.',
'type' => 'checkbox',
},
{
'key' => 'disable_settings_changes',
- 'section' => '',
+ 'section' => 'development',
'description' => 'Disable all settings changes, for demos, except for the usernames given in the comma-separated list.',
'type' => [qw( checkbox text )],
},
{
'key' => 'cust_main-edit_agent_custid',
- 'section' => 'UI',
+ 'section' => 'customer_number',
'description' => 'Enable editing of the agent_custid field.',
'type' => 'checkbox',
},
{
'key' => 'cust_main-default_agent_custid',
- 'section' => 'UI',
- 'description' => 'Display the agent_custid field when available instead of the custnum field.',
+ 'section' => 'customer_number',
+ 'description' => 'Display the agent_custid field when available instead of the custnum field. Restart Apache after changing.',
'type' => 'checkbox',
},
{
'key' => 'cust_main-title-display_custnum',
- 'section' => 'UI',
- 'description' => 'Add the display_custom (agent_custid or custnum) to the title on customer view pages.',
+ 'section' => 'customer_number',
+ 'description' => 'Add the display_custnum (agent_custid or custnum) to the title on customer view pages.',
'type' => 'checkbox',
},
{
'key' => 'cust_bill-default_agent_invid',
- 'section' => 'UI',
+ 'section' => 'invoicing',
'description' => 'Display the agent_invid field when available instead of the invnum field.',
'type' => 'checkbox',
},
{
'key' => 'cust_main-auto_agent_custid',
- 'section' => 'UI',
+ 'section' => 'customer_number',
'description' => 'Automatically assign an agent_custid - select format',
'type' => 'select',
'select_hash' => [ '' => 'No',
{
'key' => 'cust_main-custnum-display_prefix',
- 'section' => 'UI',
+ 'section' => 'customer_number',
'description' => 'Prefix the customer number with this string for display purposes.',
'type' => 'text',
'per_agent' => 1,
},
{
- 'key' => 'cust_main-custnum-display_special',
- 'section' => 'UI',
- 'description' => 'Use this customer number prefix format',
- 'type' => 'select',
- 'select_hash' => [ '' => '',
- 'CoStAg' => 'CoStAg (country, state, agent name or display_prefix)',
- 'CoStCl' => 'CoStCl (country, state, class name)' ],
- },
-
- {
'key' => 'cust_main-custnum-display_length',
- 'section' => 'UI',
- 'description' => 'Zero fill the customer number to this many digits for display purposes.',
+ 'section' => 'customer_number',
+ 'description' => 'Zero fill the customer number to this many digits for display purposes. Restart Apache after changing.',
'type' => 'text',
},
{
'key' => 'cust_main-default_areacode',
- 'section' => 'UI',
+ 'section' => 'localization',
'description' => 'Default area code for customers.',
'type' => 'text',
},
{
'key' => 'order_pkg-no_start_date',
- 'section' => 'UI',
+ 'section' => 'packages',
'description' => 'Don\'t set a default start date for new packages.',
'type' => 'checkbox',
},
{
'key' => 'part_pkg-delay_start',
- 'section' => '',
+ 'section' => 'packages',
'description' => 'Enabled "delayed start" option for packages.',
'type' => 'checkbox',
},
{
+ 'key' => 'part_pkg-delay_cancel-days',
+ 'section' => 'cancellation',
+ 'description' => 'Number of days to suspend when using automatic suspension period before cancel (default is 1)',
+ 'type' => 'text',
+ 'validate' => sub { (($_[0] =~ /^\d*$/) && (($_[0] eq '') || $_[0]))
+ ? ''
+ : 'Must specify an integer number of days' }
+ },
+
+ {
'key' => 'mcp_svcpart',
- 'section' => '',
+ 'section' => 'development',
'description' => 'Master Control Program svcpart. Leave this blank.',
'type' => 'text', #select-part_svc
},
{
'key' => 'suspend_email_admin',
- 'section' => '',
+ 'section' => 'suspension',
'description' => 'Destination admin email address to enable suspension notices',
'type' => 'text',
},
{
'key' => 'unsuspend_email_admin',
- 'section' => '',
+ 'section' => 'suspension',
'description' => 'Destination admin email address to enable unsuspension notices',
'type' => 'text',
},
{
- 'key' => 'email_report-subject',
- 'section' => '',
- 'description' => 'Subject for reports emailed by freeside-fetch. Defaults to "Freeside report".',
- 'type' => 'text',
- },
-
- {
'key' => 'selfservice-head',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML for the HEAD section of the self-service interface, typically used for LINK stylesheet tags',
'type' => 'textarea', #htmlarea?
'per_agent' => 1,
{
'key' => 'selfservice-body_header',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML header for the self-service interface',
'type' => 'textarea', #htmlarea?
'per_agent' => 1,
{
'key' => 'selfservice-body_footer',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML footer for the self-service interface',
'type' => 'textarea', #htmlarea?
'per_agent' => 1,
{
'key' => 'selfservice-body_bgcolor',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML background color for the self-service interface, for example, #FFFFFF',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-box_bgcolor',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML color for self-service interface input boxes, for example, #C0C0C0',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-stripe1_bgcolor',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML color for self-service interface lists (primary stripe), for example, #FFFFFF',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-stripe2_bgcolor',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML color for self-service interface lists (alternate stripe), for example, #DDDDDD',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-text_color',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML text color for the self-service interface, for example, #000000',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-link_color',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML link color for the self-service interface, for example, #0000FF',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-vlink_color',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML visited link color for the self-service interface, for example, #FF00FF',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-hlink_color',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML hover link color for the self-service interface, for example, #808080',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-alink_color',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML active (clicked) link color for the self-service interface, for example, #808080',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-font',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML font CSS for the self-service interface, for example, 0.9em/1.5em Arial, Helvetica, Geneva, sans-serif',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-no_logo',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'Disable the logo in self-service',
'type' => 'checkbox',
'per_agent' => 1,
{
'key' => 'selfservice-title_color',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML color for the self-service title, for example, #000000',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-title_align',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML alignment for the self-service title, for example, center',
'type' => 'text',
'per_agent' => 1,
},
{
'key' => 'selfservice-title_size',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML font size for the self-service title, for example, 3',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-title_left_image',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
'type' => 'image',
'per_agent' => 1,
{
'key' => 'selfservice-title_right_image',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
'type' => 'image',
'per_agent' => 1,
{
'key' => 'selfservice-menu_bgcolor',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML color for the self-service menu, for example, #C0C0C0',
'type' => 'text',
'per_agent' => 1,
{
'key' => 'selfservice-menu_fontsize',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'HTML font size for the self-service menu, for example, -1',
'type' => 'text',
'per_agent' => 1,
},
{
'key' => 'selfservice-menu_nounderline',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'Styles menu links in the self-service without underlining.',
'type' => 'checkbox',
'per_agent' => 1,
{
'key' => 'selfservice-menu_top_image',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
'type' => 'image',
'per_agent' => 1,
{
'key' => 'selfservice-menu_body_image',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'Repeating image used for the body of the menu in the self-service interface, in PNG format.',
'type' => 'image',
'per_agent' => 1,
{
'key' => 'selfservice-menu_bottom_image',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'Image used for the bottom of the menu in the self-service interface, in PNG format.',
'type' => 'image',
'per_agent' => 1,
{
'key' => 'selfservice-login_banner_image',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'Banner image shown on the login page, in PNG format.',
'type' => 'image',
},
{
'key' => 'selfservice-login_banner_url',
- 'section' => 'self-service',
+ 'section' => 'self-service_skinning',
'description' => 'Link for the login banner.',
'type' => 'text',
},
{
'key' => 'signup-no_company',
- 'section' => 'self-service',
+ 'section' => 'signup',
'description' => "Don't display a field for company name on signup.",
'type' => 'checkbox',
},
{
'key' => 'signup-recommend_email',
- 'section' => 'self-service',
+ 'section' => 'signup',
'description' => 'Encourage the entry of an invoicing email address on signup.',
'type' => 'checkbox',
},
{
'key' => 'signup-recommend_daytime',
- 'section' => 'self-service',
+ 'section' => 'signup',
'description' => 'Encourage the entry of a daytime phone number on signup.',
'type' => 'checkbox',
},
{
'key' => 'signup-duplicate_cc-warn_hours',
- 'section' => 'self-service',
+ 'section' => 'signup',
'description' => 'Issue a warning if the same credit card is used for multiple signups within this many hours.',
'type' => 'text',
},
{
+ 'key' => 'svc_phone-radius-password',
+ 'section' => 'telephony',
+ 'description' => 'Password when exporting svc_phone records to RADIUS',
+ 'type' => 'select',
+ 'select_hash' => [
+ '' => 'Use default from svc_phone-radius-default_password config',
+ 'countrycode_phonenum' => 'Phone number (with country code)',
+ ],
+ },
+
+ {
'key' => 'svc_phone-radius-default_password',
'section' => 'telephony',
'description' => 'Default password when exporting svc_phone records to RADIUS',
},
{
+ 'key' => 'svc_phone-bulk_provision_simple',
+ 'section' => 'telephony',
+ 'description' => 'Bulk provision phone numbers with a simple number range instead of from DID vendor orders',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'default_phone_countrycode',
- 'section' => '',
- 'description' => 'Default countrcode',
+ 'section' => 'telephony',
+ 'description' => 'Default countrycode',
'type' => 'text',
},
# },
{
+ 'key' => 'cdr-skip_duplicate_rewrite',
+ 'section' => 'telephony',
+ 'description' => 'Use the freeside-cdrrewrited daemon to prevent billing CDRs with a src, dst and calldate identical to an existing CDR',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'cdr-charged_party_rewrite',
'section' => 'telephony',
'description' => 'Do charged party rewriting in the freeside-cdrrewrited daemon; useful if CDRs are being dropped off directly in the database and require special charged_party processing such as cdr-charged_party-accountcode or cdr-charged_party-truncate*.',
},
{
+ 'key' => 'cdr-userfield_dnis_rewrite',
+ 'section' => 'telephony',
+ 'description' => 'If the CDR userfield contains "DNIS=" followed by a sequence of digits, use that as the destination number for the call.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'cdr-intl_to_domestic_rewrite',
+ 'section' => 'telephony',
+ 'description' => 'Strip the "011" international prefix from CDR destination numbers if the rest of the number is 7 digits or shorter, and so probably does not contain a country code.',
+ 'type' => 'checkbox',
+ },
+
+ {
'key' => 'cdr-gsm_tap3-sender',
'section' => 'telephony',
'description' => 'GSM TAP3 Sender network (5 letter code)',
{
'key' => 'cust_pkg-show_autosuspend',
- 'section' => 'UI',
+ 'section' => 'suspension',
'description' => 'Show package auto-suspend dates. Use with caution for now; can slow down customer view for large insallations.',
'type' => 'checkbox',
},
},
{
- 'key' => 'mc-outbound_packages',
- 'section' => '',
- 'description' => "Don't use this.",
- 'type' => 'select-part_pkg',
- 'multiple' => 1,
- },
-
- {
'key' => 'disable-cust-pkg_class',
- 'section' => 'UI',
+ 'section' => 'packages',
'description' => 'Disable the two-step dropdown for selecting package class and package, and return to the classic single dropdown.',
'type' => 'checkbox',
},
{
'key' => 'queued-max_kids',
- 'section' => '',
+ 'section' => 'scalability',
'description' => 'Maximum number of queued processes. Defaults to 10.',
'type' => 'text',
},
{
'key' => 'queued-sleep_time',
- 'section' => '',
+ 'section' => 'telephony',
'description' => 'Time to sleep between attempts to find new jobs to process in the queue. Defaults to 10. Installations doing real-time CDR processing for prepaid may want to set it lower.',
'type' => 'text',
},
{
'key' => 'queue-no_history',
- 'section' => '',
+ 'section' => 'scalability',
'description' => "Don't recreate the h_queue and h_queue_arg tables on upgrades. This can save disk space for large installs, especially when using prepaid or multi-process billing. After turning this option on, drop the h_queue and h_queue_arg tables, run freeside-dbdef-create and restart Apache and Freeside.",
'type' => 'checkbox',
},
{
'key' => 'cancelled_cust-noevents',
- 'section' => 'billing',
+ 'section' => 'cancellation',
'description' => "Don't run events for cancelled customers",
'type' => 'checkbox',
},
{
'key' => 'agent-invoice_template',
- 'section' => 'invoicing',
+ 'section' => 'deprecated',
'description' => 'Enable display/edit of old-style per-agent invoice template selection',
'type' => 'checkbox',
},
{
'key' => 'svc_broadband-manage_link',
- 'section' => 'UI',
+ 'section' => 'wireless_broadband',
'description' => 'URL for svc_broadband "Manage Device" link. The following substitutions are available: $ip_addr and $mac_addr.',
'type' => 'text',
},
{
'key' => 'svc_broadband-manage_link_text',
- 'section' => 'UI',
+ 'section' => 'wireless_broadband',
'description' => 'Label for "Manage Device" link',
'type' => 'text',
},
{
'key' => 'svc_broadband-manage_link_loc',
- 'section' => 'UI',
+ 'section' => 'wireless_broadband',
'description' => 'Location for "Manage Device" link',
'type' => 'select',
'select_hash' => [
{
'key' => 'svc_broadband-manage_link-new_window',
- 'section' => 'UI',
+ 'section' => 'wireless_broadband',
'description' => 'Open the "Manage Device" link in a new window',
'type' => 'checkbox',
},
#more fine-grained, service def-level control could be useful eventually?
{
'key' => 'svc_broadband-allow_null_ip_addr',
- 'section' => '',
+ 'section' => 'wireless_broadband',
'description' => '',
'type' => 'checkbox',
},
{
'key' => 'svc_hardware-check_mac_addr',
- 'section' => '', #?
+ 'section' => 'services',
'description' => 'Require the "hardware address" field in hardware services to be a valid MAC address.',
'type' => 'checkbox',
},
{
'key' => 'tax-report_groups',
- 'section' => '',
+ 'section' => 'taxation',
'description' => 'List of grouping possibilities for tax names on reports, one per line, "label op value" (op can be = or !=).',
'type' => 'textarea',
},
{
'key' => 'tax-cust_exempt-groups',
- 'section' => '',
+ 'section' => 'taxation',
'description' => 'List of grouping possibilities for tax names, for per-customer exemption purposes, one tax name per line. For example, "GST" would indicate the ability to exempt customers individually from taxes named "GST" (but not other taxes).',
'type' => 'textarea',
},
{
- 'key' => 'tax-cust_exempt-groups-require_individual_nums',
- 'section' => '',
- 'description' => 'When using tax-cust_exempt-groups, require an individual tax exemption number for each exemption from different taxes.',
+ 'key' => 'tax-cust_exempt-groups-num_req',
+ 'section' => 'taxation',
+ 'description' => 'When using tax-cust_exempt-groups, control whether individual tax exemption numbers are required for exemption from different taxes.',
+ 'type' => 'select',
+ 'select_hash' => [ '' => 'Not required',
+ 'residential' => 'Required for residential customers only',
+ 'all' => 'Required for all customers',
+ ],
+ },
+
+ {
+ 'key' => 'tax-round_per_line_item',
+ 'section' => 'taxation',
+ 'description' => 'Calculate tax and round to the nearest cent for each line item, rather than for the whole invoice.',
'type' => 'checkbox',
},
{
'key' => 'enable_tax_adjustments',
- 'section' => 'billing',
+ 'section' => 'taxation',
'description' => 'Enable the ability to add manual tax adjustments.',
'type' => 'checkbox',
},
{
'key' => 'rt-crontool',
- 'section' => '',
+ 'section' => 'ticketing',
'description' => 'Enable the RT CronTool extension.',
'type' => 'checkbox',
},
{
'key' => 'pkg-balances',
- 'section' => 'billing',
+ 'section' => 'packages',
'description' => 'Enable per-package balances.',
'type' => 'checkbox',
},
{
'key' => 'pkg-addon_classnum',
- 'section' => 'billing',
+ 'section' => 'packages',
'description' => 'Enable the ability to restrict additional package orders based on package class.',
'type' => 'checkbox',
},
{
'key' => 'cust_main-edit_signupdate',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'Enable manual editing of the signup date.',
'type' => 'checkbox',
},
{
'key' => 'svc_domain-edit_domain',
- 'section' => '',
+ 'section' => 'services',
'description' => 'Enable domain renaming',
'type' => 'checkbox',
},
{
'key' => 'enable_legacy_prepaid_income',
- 'section' => '',
+ 'section' => 'reporting',
'description' => "Enable legacy prepaid income reporting. Only useful when you have imported pre-Freeside packages with longer-than-monthly duration, and need to do prepaid income reporting on them before they've been invoiced the first time.",
'type' => 'checkbox',
},
{
'key' => 'cust_main-exports',
- 'section' => '',
+ 'section' => 'API',
'description' => 'Export(s) to call on cust_main insert, modification and deletion.',
'type' => 'select-sub',
'multiple' => 1,
my @part_export =
map { qsearch( 'part_export', {exporttype => $_ } ) }
keys %{FS::part_export::export_info('cust_main')};
- map { $_->exportnum => $_->exporttype.' to '.$_->machine } @part_export;
+ map { $_->exportnum => $_->exportname } @part_export;
+ },
+ 'option_sub' => sub {
+ require FS::Record;
+ require FS::part_export;
+ my $part_export = FS::Record::qsearchs(
+ 'part_export', { 'exportnum' => shift }
+ );
+ $part_export
+ ? $part_export->exportname
+ : '';
+ },
+ },
+
+ #false laziness w/above options_sub and option_sub
+ {
+ 'key' => 'cust_location-exports',
+ 'section' => 'API',
+ 'description' => 'Export(s) to call on cust_location insert or modification',
+ 'type' => 'select-sub',
+ 'multiple' => 1,
+ 'options_sub' => sub {
+ require FS::Record;
+ require FS::part_export;
+ my @part_export =
+ map { qsearch( 'part_export', {exporttype => $_ } ) }
+ keys %{FS::part_export::export_info('cust_location')};
+ map { $_->exportnum => $_->exportname } @part_export;
},
'option_sub' => sub {
require FS::Record;
'part_export', { 'exportnum' => shift }
);
$part_export
- ? $part_export->exporttype.' to '.$part_export->machine
+ ? $part_export->exportname
: '';
},
},
{
'key' => 'cust_main-custom_link',
'section' => 'UI',
- 'description' => 'URL to use as source for the "Custom" tab in the View Customer page. The customer number will be appended, or you can insert "$custnum" to have it inserted elsewhere. "$agentnum" will be replaced with the agent number, and "$usernum" will be replaced with the employee number.',
+ 'description' => 'URL to use as source for the "Custom" tab in the View Customer page. The customer number will be appended, or you can insert "$custnum" to have it inserted elsewhere. "$agentnum" will be replaced with the agent number, "$agent_custid" with be replaced with the agent customer ID (if any), and "$usernum" will be replaced with the employee number.',
'type' => 'textarea',
},
{
'key' => 'part_pkg-default_suspend_bill',
- 'section' => 'billing',
+ 'section' => 'suspension',
'description' => 'Default the "Continue recurring billing while suspended" flag to on for new package definitions.',
'type' => 'checkbox',
},
{
'key' => 'qual-alt_address_format',
- 'section' => 'UI',
+ 'section' => 'addresses',
'description' => 'Enable the alternate address format (location type, number, and kind) for qualifications.',
'type' => 'checkbox',
},
{
'key' => 'note-classes',
- 'section' => 'UI',
- 'description' => 'Use customer note classes',
+ 'section' => 'deprecated',
+ 'description' => 'Use customer note classes (now automatically used if classes are defined)',
'type' => 'select',
'select_hash' => [
0 => 'Disabled',
{
'key' => 'svc_acct-cf_privatekey-message',
- 'section' => '',
+ 'section' => 'development',
'description' => 'For internal use: HTML displayed when cf_privatekey field is set.',
'type' => 'textarea',
},
{
'key' => 'svc_phone-did-summary',
- 'section' => 'invoicing',
+ 'section' => 'telephony',
'description' => 'Experimental feature to enable DID activity summary on invoices, showing # DIDs activated/deactivated/ported-in/ported-out and total minutes usage, covering period since last invoice.',
'type' => 'checkbox',
},
{
'key' => 'svc_acct-usage_seconds',
- 'section' => 'invoicing',
+ 'section' => 'RADIUS',
'description' => 'Enable calculation of RADIUS usage time for invoices. You must modify your template to display this information.',
'type' => 'checkbox',
},
{
'key' => 'cust_bill-no_recipients-error',
- 'section' => 'invoicing',
+ 'section' => 'invoice_email',
'description' => 'For customers with no invoice recipients, throw a job queue error rather than the default behavior of emailing the invoice to the invoice_from address.',
'type' => 'checkbox',
},
{
'key' => 'cust_bill-latex_lineitem_maxlength',
- 'section' => 'invoicing',
- 'description' => 'Truncate long line items to this number of characters on typeset invoices, to avoid losing things off the right margin. Defaults to 50. ',
+ 'section' => 'deprecated',
+ 'description' => 'With old invoice_latex template, truncate long line items to this number of characters on typeset invoices, to avoid losing things off the right margin. (With current invoice_latex template, this is handled internally in the template itself instead.)',
'type' => 'text',
},
{
'key' => 'cust_main-status_module',
'section' => 'UI',
- 'description' => 'Which module to use for customer status display. The "Classic" module (the default) considers accounts with cancelled recurring packages but un-cancelled one-time charges Inactive. The "Recurring" module considers those customers Cancelled. Similarly for customers with suspended recurring packages but one-time charges.', #other differences?
+ 'description' => 'Which module to use for customer status display. The "Classic" module (the default) considers accounts with cancelled recurring packages but un-cancelled one-time charges Inactive. The "Recurring" module considers those customers Cancelled. Similarly for customers with suspended recurring packages but one-time charges. Restart Apache after changing.', #other differences?
'type' => 'select',
'select_enum' => [ 'Classic', 'Recurring' ],
},
{
'key' => 'ie-compatibility_mode',
- 'section' => 'UI',
+ 'section' => 'deprecated',
'description' => "Compatibility mode META tag for Internet Explorer, used on the customer view page. Not necessary in normal operation unless custom content (notes, cust_main-custom_link) is included on customer view that is incompatibile with newer IE verisons.",
'type' => 'select',
'select_enum' => [ '', '7', 'EmulateIE7', '8', 'EmulateIE8' ],
{
'key' => 'disable_payauto_default',
- 'section' => 'UI',
+ 'section' => 'payments',
'description' => 'Disable the "Charge future payments to this (card|check) automatically" checkbox from defaulting to checked.',
'type' => 'checkbox',
},
{
'key' => 'payment-history-report',
- 'section' => 'UI',
- 'description' => 'Show a link to the raw database payment history report in the Reports menu. DO NOT ENABLE THIS for modern installations.',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'svc_broadband-require-nw-coordinates',
'section' => 'deprecated',
- 'description' => 'Deprecated; see geocode-require_nw_coordinates instead',
- 'type' => 'checkbox',
- },
-
- {
- 'key' => 'cust-email-high-visibility',
- 'section' => 'UI',
- 'description' => 'Move the invoicing e-mail address field to the top of the billing address section and highlight it.',
+ 'description' => 'Show a link to the raw database payment history report in the Reports menu. DO NOT ENABLE THIS for modern installations.',
'type' => 'checkbox',
},
{
'key' => 'cust-edit-alt-field-order',
- 'section' => 'UI',
+ 'section' => 'customer_fields',
'description' => 'An alternate ordering of fields for the New Customer and Edit Customer screens.',
'type' => 'checkbox',
},
{
'key' => 'available-locales',
- 'section' => '',
+ 'section' => 'localization',
'description' => 'Limit available locales (employee preferences, per-customer locale selection, etc.) to a particular set.',
'type' => 'select-sub',
'multiple' => 1,
'options_sub' => sub {
map { $_ => FS::Locales->description($_) }
- grep { $_ ne 'en_US' }
FS::Locales->locales;
},
'option_sub' => sub { FS::Locales->description(shift) },
{
'key' => 'cust_main-require_locale',
- 'section' => 'UI',
+ 'section' => 'localization',
'description' => 'Require an explicit locale to be chosen for new customers.',
'type' => 'checkbox',
},
{
'key' => 'translate-auto-insert',
- 'section' => '',
- 'description' => 'Auto-insert untranslated strings for selected non-en_US locales with their default/en_US values. Do not turn this on unless translating the interface into a new language.',
+ 'section' => 'localization',
+ 'description' => 'Auto-insert untranslated strings for selected non-en_US locales with their default/en_US values. Do not turn this on unless translating the interface into a new language. Restart Apache after changing.',
'type' => 'select',
'multiple' => 1,
'select_enum' => [ grep { $_ ne 'en_US' } FS::Locales::locales ],
{
'key' => 'svc_acct-tower_sector',
- 'section' => '',
+ 'section' => 'services',
'description' => 'Track tower and sector for svc_acct (account) services.',
'type' => 'checkbox',
},
'rate_low' => 'Lowest rate first',
],
},
+
+ {
+ 'key' => 'cdr-lrn_lookup',
+ 'section' => 'telephony',
+ 'description' => 'Look up LRNs of destination numbers for exact matching to the terminating carrier. This feature requires a Freeside support contract for paid access to the central NPAC database; see <a href ="#support-key">support-key</a>.',
+ 'type' => 'checkbox',
+ },
{
'key' => 'brand-agent',
{
'key' => 'cust_class-tax_exempt',
- 'section' => 'billing',
+ 'section' => 'taxation',
'description' => 'Control the tax exemption flag per customer class rather than per indivual customer.',
'type' => 'checkbox',
},
},
{
+ 'key' => 'selfservice-hide_cdr_price',
+ 'section' => 'self-service',
+ 'description' => 'Don\'t show the "Price" column on CDRs in self-service.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'selfservice-enable_payment_without_balance',
+ 'section' => 'self-service',
+ 'description' => 'Allow selfservice customers to make payments even if balance is zero or below (resulting in an unapplied payment and negative balance.)',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'selfservice-announcement',
+ 'section' => 'self-service',
+ 'description' => 'HTML announcement to display to all authenticated users on account overview page',
+ 'type' => 'textarea',
+ },
+
+ {
'key' => 'logout-timeout',
'section' => 'UI',
'description' => 'If set, automatically log users out of the backoffice after this many minutes.',
{
'key' => 'spreadsheet_format',
- 'section' => 'UI',
+ 'section' => 'reporting',
'description' => 'Default format for spreadsheet download.',
'type' => 'select',
'select_hash' => [
},
{
- 'key' => 'agent-email_day',
- 'section' => '',
- 'description' => 'On this day of each month, agents with master customer records containing email addresses will be emailed a list of their customers and balances.',
- 'type' => 'text',
- },
-
- {
'key' => 'report-cust_pay-select_time',
- 'section' => 'UI',
+ 'section' => 'reporting',
'description' => 'Enable time selection on payment and refund reports.',
'type' => 'checkbox',
},
{
'key' => 'allow_invalid_cards',
- 'section' => '',
+ 'section' => 'development',
'description' => 'Accept invalid credit card numbers. Useful for testing with fictitious customers. There is no good reason to enable this in production.',
'type' => 'checkbox',
},
- { key => "apacheroot", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "apachemachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "apachemachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "bindprimary", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "bindsecondaries", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "bsdshellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "cyrus", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "cp_app", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "erpcdmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "icradiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "icradius_mysqldest", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "icradius_mysqlsource", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "icradius_secrets", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "maildisablecatchall", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "mxmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "nsmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "arecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "cnamerecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "nismachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "qmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "radiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "sendmailconfigpath", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "sendmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "sendmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "shellmachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "shellmachine-useradd", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "shellmachine-userdel", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "shellmachine-usermod", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "shellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "radiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "textradiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "username_policy", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "vpopmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "vpopmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "safe-part_pkg", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "selfservice_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "signup_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "signup_server-email", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "vonage-username", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "vonage-password", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
- { key => "vonage-fromnumber", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
+ {
+ 'key' => 'default_credit_limit',
+ 'section' => 'billing',
+ 'description' => 'Default customer credit limit',
+ 'type' => 'text',
+ },
+
+ {
+ 'key' => 'api_shared_secret',
+ 'section' => 'API',
+ 'description' => 'Shared secret for back-office API authentication',
+ 'type' => 'text',
+ },
+
+ {
+ 'key' => 'xmlrpc_api',
+ 'section' => 'API',
+ 'description' => 'Enable the back-office API XML-RPC server (on port 8008).',
+ 'type' => 'checkbox',
+ },
+
+# {
+# 'key' => 'jsonrpc_api',
+# 'section' => 'API',
+# 'description' => 'Enable the back-office API JSON-RPC server (on port 8081).',
+# 'type' => 'checkbox',
+# },
+
+ {
+ 'key' => 'api_credit_reason',
+ 'section' => 'API',
+ 'description' => 'Default reason for back-office API credits',
+ 'type' => 'select-sub',
+ #false laziness w/api_credit_reason
+ 'options_sub' => sub { require FS::Record;
+ require FS::reason;
+ my $type = qsearchs('reason_type',
+ { class => 'R' })
+ or return ();
+ map { $_->reasonnum => $_->reason }
+ FS::Record::qsearch('reason',
+ { reason_type => $type->typenum }
+ );
+ },
+ 'option_sub' => sub { require FS::Record;
+ require FS::reason;
+ my $reason = FS::Record::qsearchs(
+ 'reason', { 'reasonnum' => shift }
+ );
+ $reason ? $reason->reason : '';
+ },
+ },
+
+ {
+ 'key' => 'part_pkg-term_discounts',
+ 'section' => 'packages',
+ 'description' => 'Enable the term discounts feature. Recommended to keep turned off unless actually using - not well optimized for large installations.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'prepaid-never_renew',
+ 'section' => 'packages',
+ 'description' => 'Prepaid packages never renew.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'agent-disable_counts',
+ 'section' => 'scalability',
+ 'description' => 'On the agent browse page, disable the customer and package counts. Typically used for very large installs when this page takes too long to render.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'tollfree-country',
+ 'section' => 'telephony',
+ 'description' => 'Country / region for toll-free recognition',
+ 'type' => 'select',
+ 'select_hash' => [ '' => 'NANPA (US/Canada)',
+ 'AU' => 'Australia',
+ 'NZ' => 'New Zealand',
+ ],
+ },
+
+ {
+ 'key' => 'old_fcc_report',
+ 'section' => 'deprecated',
+ 'description' => 'Use the old (pre-2014) FCC Form 477 report format.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'cust_main-default_commercial',
+ 'section' => 'customer_fields',
+ 'description' => 'Default for new customers is commercial rather than residential.',
+ 'type' => 'checkbox',
+ },
+
+ {
+ 'key' => 'default_appointment_length',
+ 'section' => 'appointments',
+ 'description' => 'Default appointment length, in minutes (30 minute granularity).',
+ 'type' => 'text',
+ },
+
+ # for internal use only; test databases should declare this option and
+ # everyone else should pretend it doesn't exist
+ #{
+ # 'key' => 'no_random_ids',
+ # 'section' => '',
+ # 'description' => 'Replace random identifiers in UI code with a static string, for repeatable testing. Don\'t use in production.',
+ # 'type' => 'checkbox',
+ #},
);