FS/FS/Conf.pm

   1 package FS::Conf;
   2
   3 use vars qw($base_dir @config_items @base_items @card_types $DEBUG);
   4 use Carp;
   5 use IO::File;
   6 use File::Basename;
   7 use MIME::Base64;
   8 use FS::ConfItem;
   9 use FS::ConfDefaults;
  10 use FS::Conf_compat17;
  11 use FS::payby;
  12 use FS::conf;
  13 use FS::Record qw(qsearch qsearchs);
  14 use FS::UID qw(dbh datasrc use_confcompat);
  15
  16 $base_dir = '%%%FREESIDE_CONF%%%';
  17
  18 $DEBUG = 0;
  19
  20 =head1 NAME
  21
  22 FS::Conf - Freeside configuration values
  23
  24 =head1 SYNOPSIS
  25
  26   use FS::Conf;
  27
  28   $conf = new FS::Conf;
  29
  30   $value = $conf->config('key');
  31   @list  = $conf->config('key');
  32   $bool  = $conf->exists('key');
  33
  34   $conf->touch('key');
  35   $conf->set('key' => 'value');
  36   $conf->delete('key');
  37
  38   @config_items = $conf->config_items;
  39
  40 =head1 DESCRIPTION
  41
  42 Read and write Freeside configuration values.  Keys currently map to filenames,
  43 but this may change in the future.
  44
  45 =head1 METHODS
  46
  47 =over 4
  48
  49 =item new
  50
  51 Create a new configuration object.
  52
  53 =cut
  54
  55 sub new {
  56   my($proto) = @_;
  57   my($class) = ref($proto) || $proto;
  58   my($self) = { 'base_dir' => $base_dir };
  59   bless ($self, $class);
  60 }
  61
  62 =item base_dir
  63
  64 Returns the base directory.  By default this is /usr/local/etc/freeside.
  65
  66 =cut
  67
  68 sub base_dir {
  69   my($self) = @_;
  70   my $base_dir = $self->{base_dir};
  71   -e $base_dir or die "FATAL: $base_dir doesn't exist!";
  72   -d $base_dir or die "FATAL: $base_dir isn't a directory!";
  73   -r $base_dir or die "FATAL: Can't read $base_dir!";
  74   -x $base_dir or die "FATAL: $base_dir not searchable (executable)!";
  75   $base_dir =~ /^(.*)$/;
  76   $1;
  77 }
  78
  79 =item conf KEY [ AGENTNUM [ NODEFAULT ] ]
  80
  81 Returns the L<FS::conf> record for the key and agent.
  82
  83 =cut
  84
  85 sub conf {
  86   my $self = shift;
  87   $self->_config(@_);
  88 }
  89
  90 =item config KEY [ AGENTNUM [ NODEFAULT ] ]
  91
  92 Returns the configuration value or values (depending on context) for key.
  93 The optional agent number selects an agent specific value instead of the
  94 global default if one is present.  If NODEFAULT is true only the agent
  95 specific value(s) is returned.
  96
  97 =cut
  98
  99 sub _usecompat {
 100   my ($self, $method) = (shift, shift);
 101   carp "NO CONFIGURATION RECORDS FOUND -- USING COMPATIBILITY MODE"
 102     if use_confcompat;
 103   my $compat = new FS::Conf_compat17 ("$base_dir/conf." . datasrc);
 104   $compat->$method(@_);
 105 }
 106
 107 sub _config {
 108   my($self,$name,$agentnum,$agentonly)=@_;
 109   my $hashref = { 'name' => $name };
 110   $hashref->{agentnum} = $agentnum;
 111   local $FS::Record::conf = undef;  # XXX evil hack prevents recursion
 112   my $cv = FS::Record::qsearchs('conf', $hashref);
 113   if (!$agentonly && !$cv && defined($agentnum) && $agentnum) {
 114     $hashref->{agentnum} = '';
 115     $cv = FS::Record::qsearchs('conf', $hashref);
 116   }
 117   return $cv;
 118 }
 119
 120 sub config {
 121   my $self = shift;
 122   return $self->_usecompat('config', @_) if use_confcompat;
 123
 124   carp "FS::Conf->config(". join(', ', @_). ") called"
 125     if $DEBUG > 1;
 126
 127   my $cv = $self->_config(@_) or return;
 128
 129   if ( wantarray ) {
 130     my $v = $cv->value;
 131     chomp $v;
 132     (split "\n", $v, -1);
 133   } else {
 134     (split("\n", $cv->value))[0];
 135   }
 136 }
 137
 138 =item config_binary KEY [ AGENTNUM [ NODEFAULT ] ]
 139
 140 Returns the exact scalar value for key.
 141
 142 =cut
 143
 144 sub config_binary {
 145   my $self = shift;
 146   return $self->_usecompat('config_binary', @_) if use_confcompat;
 147
 148   my $cv = $self->_config(@_) or return;
 149   length($cv->value) ? decode_base64($cv->value) : '';
 150 }
 151
 152 =item exists KEY [ AGENTNUM [ NODEFAULT ] ]
 153
 154 Returns true if the specified key exists, even if the corresponding value
 155 is undefined.
 156
 157 =cut
 158
 159 sub exists {
 160   my $self = shift;
 161   return $self->_usecompat('exists', @_) if use_confcompat;
 162
 163   my($name, $agentnum)=@_;
 164
 165   carp "FS::Conf->exists(". join(', ', @_). ") called"
 166     if $DEBUG > 1;
 167
 168   defined($self->_config(@_));
 169 }
 170
 171 =item config_orbase KEY SUFFIX
 172
 173 Returns the configuration value or values (depending on context) for
 174 KEY_SUFFIX, if it exists, otherwise for KEY
 175
 176 =cut
 177
 178 # outmoded as soon as we shift to agentnum based config values
 179 # well, mostly.  still useful for e.g. late notices, etc. in that we want
 180 # these to fall back to standard values
 181 sub config_orbase {
 182   my $self = shift;
 183   return $self->_usecompat('config_orbase', @_) if use_confcompat;
 184
 185   my( $name, $suffix ) = @_;
 186   if ( $self->exists("${name}_$suffix") ) {
 187     $self->config("${name}_$suffix");
 188   } else {
 189     $self->config($name);
 190   }
 191 }
 192
 193 =item key_orbase KEY SUFFIX
 194
 195 If the config value KEY_SUFFIX exists, returns KEY_SUFFIX, otherwise returns
 196 KEY.  Useful for determining which exact configuration option is returned by
 197 config_orbase.
 198
 199 =cut
 200
 201 sub key_orbase {
 202   my $self = shift;
 203   #no compat for this...return $self->_usecompat('config_orbase', @_) if use_confcompat;
 204
 205   my( $name, $suffix ) = @_;
 206   if ( $self->exists("${name}_$suffix") ) {
 207     "${name}_$suffix";
 208   } else {
 209     $name;
 210   }
 211 }
 212
 213 =item invoice_templatenames
 214
 215 Returns all possible invoice template names.
 216
 217 =cut
 218
 219 sub invoice_templatenames {
 220   my( $self ) = @_;
 221
 222   my %templatenames = ();
 223   foreach my $item ( $self->config_items ) {
 224     foreach my $base ( @base_items ) {
 225       my( $main, $ext) = split(/\./, $base);
 226       $ext = ".$ext" if $ext;
 227       if ( $item->key =~ /^${main}_(.+)$ext$/ ) {
 228       $templatenames{$1}++;
 229       }
 230     }
 231   }
 232
 233   map { $_ } #handle scalar context
 234   sort keys %templatenames;
 235
 236 }
 237
 238 =item touch KEY [ AGENT ];
 239
 240 Creates the specified configuration key if it does not exist.
 241
 242 =cut
 243
 244 sub touch {
 245   my $self = shift;
 246   return $self->_usecompat('touch', @_) if use_confcompat;
 247
 248   my($name, $agentnum) = @_;
 249   unless ( $self->exists($name, $agentnum) ) {
 250     $self->set($name, '', $agentnum);
 251   }
 252 }
 253
 254 =item set KEY VALUE [ AGENTNUM ];
 255
 256 Sets the specified configuration key to the given value.
 257
 258 =cut
 259
 260 sub set {
 261   my $self = shift;
 262   return $self->_usecompat('set', @_) if use_confcompat;
 263
 264   my($name, $value, $agentnum) = @_;
 265   $value =~ /^(.*)$/s;
 266   $value = $1;
 267
 268   warn "[FS::Conf] SET $name\n" if $DEBUG;
 269
 270   my $old = FS::Record::qsearchs('conf', {name => $name, agentnum => $agentnum});
 271   my $new = new FS::conf { $old ? $old->hash
 272                                 : ('name' => $name, 'agentnum' => $agentnum)
 273                          };
 274   $new->value($value);
 275
 276   my $error;
 277   if ($old) {
 278     $error = $new->replace($old);
 279   } else {
 280     $error = $new->insert;
 281   }
 282
 283   die "error setting configuration value: $error \n"
 284     if $error;
 285
 286 }
 287
 288 =item set_binary KEY VALUE [ AGENTNUM ]
 289
 290 Sets the specified configuration key to an exact scalar value which
 291 can be retrieved with config_binary.
 292
 293 =cut
 294
 295 sub set_binary {
 296   my $self  = shift;
 297   return if use_confcompat;
 298
 299   my($name, $value, $agentnum)=@_;
 300   $self->set($name, encode_base64($value), $agentnum);
 301 }
 302
 303 =item delete KEY [ AGENTNUM ];
 304
 305 Deletes the specified configuration key.
 306
 307 =cut
 308
 309 sub delete {
 310   my $self = shift;
 311   return $self->_usecompat('delete', @_) if use_confcompat;
 312
 313   my($name, $agentnum) = @_;
 314   if ( my $cv = FS::Record::qsearchs('conf', {name => $name, agentnum => $agentnum}) ) {
 315     warn "[FS::Conf] DELETE $name\n";
 316
 317     my $oldAutoCommit = $FS::UID::AutoCommit;
 318     local $FS::UID::AutoCommit = 0;
 319     my $dbh = dbh;
 320
 321     my $error = $cv->delete;
 322
 323     if ( $error ) {
 324       $dbh->rollback if $oldAutoCommit;
 325       die "error setting configuration value: $error \n"
 326     }
 327
 328     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 329
 330   }
 331 }
 332
 333 =item import_config_item CONFITEM DIR
 334
 335   Imports the item specified by the CONFITEM (see L<FS::ConfItem>) into
 336 the database as a conf record (see L<FS::conf>).  Imports from the file
 337 in the directory DIR.
 338
 339 =cut
 340
 341 sub import_config_item {
 342   my ($self,$item,$dir) = @_;
 343   my $key = $item->key;
 344   if ( -e "$dir/$key" && ! use_confcompat ) {
 345     warn "Inserting $key\n" if $DEBUG;
 346     local $/;
 347     my $value = readline(new IO::File "$dir/$key");
 348     if ($item->type =~ /^(binary|image)$/ ) {
 349       $self->set_binary($key, $value);
 350     }else{
 351       $self->set($key, $value);
 352     }
 353   }else {
 354     warn "Not inserting $key\n" if $DEBUG;
 355   }
 356 }
 357
 358 =item verify_config_item CONFITEM DIR
 359
 360   Compares the item specified by the CONFITEM (see L<FS::ConfItem>) in
 361 the database to the legacy file value in DIR.
 362
 363 =cut
 364
 365 sub verify_config_item {
 366   return '' if use_confcompat;
 367   my ($self,$item,$dir) = @_;
 368   my $key = $item->key;
 369   my $type = $item->type;
 370
 371   my $compat = new FS::Conf_compat17 $dir;
 372   my $error = '';
 373
 374   $error .= "$key fails existential comparison; "
 375     if $self->exists($key) xor $compat->exists($key);
 376
 377   if ( $type !~ /^(binary|image)$/ ) {
 378
 379     {
 380       no warnings;
 381       $error .= "$key fails scalar comparison; "
 382         unless scalar($self->config($key)) eq scalar($compat->config($key));
 383     }
 384
 385     my (@new) = $self->config($key);
 386     my (@old) = $compat->config($key);
 387     unless ( scalar(@new) == scalar(@old)) {
 388       $error .= "$key fails list comparison; ";
 389     }else{
 390       my $r=1;
 391       foreach (@old) { $r=0 if ($_ cmp shift(@new)); }
 392       $error .= "$key fails list comparison; "
 393         unless $r;
 394     }
 395
 396   } else {
 397
 398     no warnings 'uninitialized';
 399     $error .= "$key fails binary comparison; "
 400       unless scalar($self->config_binary($key)) eq scalar($compat->config_binary($key));
 401
 402   }
 403
 404 #remove deprecated config on our own terms, not freeside-upgrade's
 405 #  if ($error =~ /existential comparison/ && $item->section eq 'deprecated') {
 406 #    my $proto;
 407 #    for ( @config_items ) { $proto = $_; last if $proto->key eq $key;  }
 408 #    unless ($proto->key eq $key) {
 409 #      warn "removed config item $error\n" if $DEBUG;
 410 #      $error = '';
 411 #    }
 412 #  }
 413
 414   $error;
 415 }
 416
 417 #item _orbase_items OPTIONS
 418 #
 419 #Returns all of the possible extensible config items as FS::ConfItem objects.
 420 #See #L<FS::ConfItem>.  OPTIONS consists of name value pairs.  Possible
 421 #options include
 422 #
 423 # dir - the directory to search for configuration option files instead
 424 #       of using the conf records in the database
 425 #
 426 #cut
 427
 428 #quelle kludge
 429 sub _orbase_items {
 430   my ($self, %opt) = @_;
 431
 432   my $listmaker = sub { my $v = shift;
 433                         $v =~ s/_/!_/g;
 434                         if ( $v =~ /\.(png|eps)$/ ) {
 435                           $v =~ s/\./!_%./;
 436                         }else{
 437                           $v .= '!_%';
 438                         }
 439                         map { $_->name }
 440                           FS::Record::qsearch( 'conf',
 441                                                {},
 442                                                '',
 443                                                "WHERE name LIKE '$v' ESCAPE '!'"
 444                                              );
 445                       };
 446
 447   if (exists($opt{dir}) && $opt{dir}) {
 448     $listmaker = sub { my $v = shift;
 449                        if ( $v =~ /\.(png|eps)$/ ) {
 450                          $v =~ s/\./_*./;
 451                        }else{
 452                          $v .= '_*';
 453                        }
 454                        map { basename $_ } glob($opt{dir}. "/$v" );
 455                      };
 456   }
 457
 458   ( map {
 459           my $proto;
 460           my $base = $_;
 461           for ( @config_items ) { $proto = $_; last if $proto->key eq $base;  }
 462           die "don't know about $base items" unless $proto->key eq $base;
 463
 464           map { new FS::ConfItem {
 465                   'key'         => $_,
 466                   'base_key'    => $proto->key,
 467                   'section'     => $proto->section,
 468                   '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.',
 469                   'type'        => $proto->type,
 470                 };
 471               } &$listmaker($base);
 472         } @base_items,
 473   );
 474 }
 475
 476 =item config_items
 477
 478 Returns all of the possible global/default configuration items as
 479 FS::ConfItem objects.  See L<FS::ConfItem>.
 480
 481 =cut
 482
 483 sub config_items {
 484   my $self = shift;
 485   return $self->_usecompat('config_items', @_) if use_confcompat;
 486
 487   ( @config_items, $self->_orbase_items(@_) );
 488 }
 489
 490 =back
 491
 492 =head1 SUBROUTINES
 493
 494 =over 4
 495
 496 =item init-config DIR
 497
 498 Imports the configuration items from DIR (1.7 compatible)
 499 to conf records in the database.
 500
 501 =cut
 502
 503 sub init_config {
 504   my $dir = shift;
 505
 506   {
 507     local $FS::UID::use_confcompat = 0;
 508     my $conf = new FS::Conf;
 509     foreach my $item ( $conf->config_items(dir => $dir) ) {
 510       $conf->import_config_item($item, $dir);
 511       my $error = $conf->verify_config_item($item, $dir);
 512       return $error if $error;
 513     }
 514
 515     my $compat = new FS::Conf_compat17 $dir;
 516     foreach my $item ( $compat->config_items ) {
 517       my $error = $conf->verify_config_item($item, $dir);
 518       return $error if $error;
 519     }
 520   }
 521
 522   $FS::UID::use_confcompat = 0;
 523   '';  #success
 524 }
 525
 526 =back
 527
 528 =head1 BUGS
 529
 530 If this was more than just crud that will never be useful outside Freeside I'd
 531 worry that config_items is freeside-specific and icky.
 532
 533 =head1 SEE ALSO
 534
 535 "Configuration" in the web interface (config/config.cgi).
 536
 537 =cut
 538
 539 #Business::CreditCard
 540 @card_types = (
 541   "VISA card",
 542   "MasterCard",
 543   "Discover card",
 544   "American Express card",
 545   "Diner's Club/Carte Blanche",
 546   "enRoute",
 547   "JCB",
 548   "BankCard",
 549   "Switch",
 550   "Solo",
 551 );
 552
 553 @base_items = qw(
 554 invoice_template
 555 invoice_latex
 556 invoice_latexreturnaddress
 557 invoice_latexfooter
 558 invoice_latexsmallfooter
 559 invoice_latexnotes
 560 invoice_latexcoupon
 561 invoice_html
 562 invoice_htmlreturnaddress
 563 invoice_htmlfooter
 564 invoice_htmlnotes
 565 logo.png
 566 logo.eps
 567 );
 568
 569 my %msg_template_options = (
 570   'type'        => 'select-sub',
 571   'options_sub' => sub {
 572     my @templates = qsearch({
 573         'table' => 'msg_template',
 574         'hashref' => { 'disabled' => '' },
 575         'extra_sql' => ' AND '.
 576           $FS::CurrentUser::CurrentUser->agentnums_sql(null => 1),
 577         });
 578     map { $_->msgnum, $_->msgname } @templates;
 579   },
 580   'option_sub'  => sub {
 581                          my $msg_template = FS::msg_template->by_key(shift);
 582                          $msg_template ? $msg_template->msgname : ''
 583                        },
 584   'per_agent' => 1,
 585 );
 586
 587 my $_gateway_name = sub {
 588   my $g = shift;
 589   return '' if !$g;
 590   ($g->gateway_username . '@' . $g->gateway_module);
 591 };
 592
 593 my %payment_gateway_options = (
 594   'type'        => 'select-sub',
 595   'options_sub' => sub {
 596     my @gateways = qsearch({
 597         'table' => 'payment_gateway',
 598         'hashref' => { 'disabled' => '' },
 599       });
 600     map { $_->gatewaynum, $_gateway_name->($_) } @gateways;
 601   },
 602   'option_sub'  => sub {
 603     my $gateway = FS::payment_gateway->by_key(shift);
 604     $_gateway_name->($gateway);
 605   },
 606 );
 607
 608 #Billing (81 items)
 609 #Invoicing (50 items)
 610 #UI (69 items)
 611 #Self-service (29 items)
 612 #...
 613 #Unclassified (77 items)
 614
 615 @config_items = map { new FS::ConfItem $_ } (
 616
 617   {
 618     'key'         => 'address',
 619     'section'     => 'deprecated',
 620     'description' => 'This configuration option is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.',
 621     'type'        => 'text',
 622   },
 623
 624   {
 625     'key'         => 'alert_expiration',
 626     'section'     => 'notification',
 627     'description' => 'Enable alerts about billing method expiration (i.e. expiring credit cards).',
 628     'type'        => 'checkbox',
 629     'per_agent'   => 1,
 630   },
 631
 632   {
 633     'key'         => 'alerter_template',
 634     'section'     => 'deprecated',
 635     'description' => 'Template file for billing method expiration alerts (i.e. expiring credit cards).',
 636     'type'        => 'textarea',
 637     'per_agent'   => 1,
 638   },
 639
 640   {
 641     'key'         => 'alerter_msgnum',
 642     'section'     => 'notification',
 643     'description' => 'Template to use for credit card expiration alerts.',
 644     %msg_template_options,
 645   },
 646
 647   {
 648     'key'         => 'apacheip',
 649     #not actually deprecated yet
 650     #'section'     => 'deprecated',
 651     #'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',
 652     'section'     => '',
 653     'description' => 'IP address to assign to new virtual hosts',
 654     'type'        => 'text',
 655   },
 656
 657   {
 658     'key'         => 'credit-card-surcharge-percentage',
 659     'section'     => 'billing',
 660     '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.',
 661     'type'        => 'text',
 662   },
 663
 664   {
 665     'key'         => 'discount-show-always',
 666     'section'     => 'billing',
 667     'description' => 'Generate a line item on an invoice even when a package is discounted 100%',
 668     'type'        => 'checkbox',
 669   },
 670
 671   {
 672     'key'         => 'encryption',
 673     'section'     => 'billing',
 674     'description' => 'Enable encryption of credit cards.',
 675     'type'        => 'checkbox',
 676   },
 677
 678   {
 679     'key'         => 'encryptionmodule',
 680     'section'     => 'billing',
 681     'description' => 'Use which module for encryption?',
 682     'type'        => 'text',
 683   },
 684
 685   {
 686     'key'         => 'encryptionpublickey',
 687     'section'     => 'billing',
 688     'description' => 'Your RSA Public Key - Required if Encryption is turned on.',
 689     'type'        => 'textarea',
 690   },
 691
 692   {
 693     'key'         => 'encryptionprivatekey',
 694     'section'     => 'billing',
 695     'description' => 'Your RSA Private Key - Including this will enable the "Bill Now" feature.  However if the system is compromised, a hacker can use this key to decode the stored credit card information.  This is generally not a good idea.',
 696     'type'        => 'textarea',
 697   },
 698
 699   {
 700     'key'         => 'billco-url',
 701     'section'     => 'billing',
 702     'description' => 'The url to use for performing uploads to the invoice mailing service.',
 703     'type'        => 'text',
 704     'per_agent'   => 1,
 705   },
 706
 707   {
 708     'key'         => 'billco-username',
 709     'section'     => 'billing',
 710     'description' => 'The login name to use for uploads to the invoice mailing service.',
 711     'type'        => 'text',
 712     'per_agent'   => 1,
 713     'agentonly'   => 1,
 714   },
 715
 716   {
 717     'key'         => 'billco-password',
 718     'section'     => 'billing',
 719     'description' => 'The password to use for uploads to the invoice mailing service.',
 720     'type'        => 'text',
 721     'per_agent'   => 1,
 722     'agentonly'   => 1,
 723   },
 724
 725   {
 726     'key'         => 'billco-clicode',
 727     'section'     => 'billing',
 728     'description' => 'The clicode to use for uploads to the invoice mailing service.',
 729     'type'        => 'text',
 730     'per_agent'   => 1,
 731   },
 732
 733   {
 734     'key'         => 'business-onlinepayment',
 735     'section'     => 'billing',
 736     '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.',
 737     'type'        => 'textarea',
 738   },
 739
 740   {
 741     'key'         => 'business-onlinepayment-ach',
 742     'section'     => 'billing',
 743     '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.',
 744     'type'        => 'textarea',
 745   },
 746
 747   {
 748     'key'         => 'business-onlinepayment-namespace',
 749     'section'     => 'billing',
 750     'description' => 'Specifies which perl module namespace (which group of collection routines) is used by default.',
 751     'type'        => 'select',
 752     'select_hash' => [
 753                        'Business::OnlinePayment' => 'Direct API (Business::OnlinePayment)',
 754                        'Business::OnlineThirdPartyPayment' => 'Web API (Business::ThirdPartyPayment)',
 755                      ],
 756   },
 757
 758   {
 759     'key'         => 'business-onlinepayment-description',
 760     'section'     => 'billing',
 761     '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)',
 762     'type'        => 'text',
 763   },
 764
 765   {
 766     'key'         => 'business-onlinepayment-email-override',
 767     'section'     => 'billing',
 768     'description' => 'Email address used instead of customer email address when submitting a BOP transaction.',
 769     'type'        => 'text',
 770   },
 771
 772   {
 773     'key'         => 'business-onlinepayment-email_customer',
 774     'section'     => 'billing',
 775     'description' => 'Controls the "email_customer" flag used by some Business::OnlinePayment processors to enable customer receipts.',
 776     'type'        => 'checkbox',
 777   },
 778
 779   {
 780     'key'         => 'business-onlinepayment-test_transaction',
 781     'section'     => 'billing',
 782     '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.',
 783     'type'        => 'checkbox',
 784   },
 785
 786   {
 787     'key'         => 'countrydefault',
 788     'section'     => 'UI',
 789     'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
 790     'type'        => 'text',
 791   },
 792
 793   {
 794     'key'         => 'date_format',
 795     'section'     => 'UI',
 796     'description' => 'Format for displaying dates',
 797     'type'        => 'select',
 798     'select_hash' => [
 799                        '%m/%d/%Y' => 'MM/DD/YYYY',
 800                        '%d/%m/%Y' => 'DD/MM/YYYY',
 801                        '%Y/%m/%d' => 'YYYY/MM/DD',
 802                      ],
 803   },
 804
 805   {
 806     'key'         => 'date_format_long',
 807     'section'     => 'UI',
 808     'description' => 'Verbose format for displaying dates',
 809     'type'        => 'select',
 810     'select_hash' => [
 811                        '%b %o, %Y' => 'Mon DDth, YYYY',
 812                        '%e %b %Y'  => 'DD Mon YYYY',
 813                      ],
 814   },
 815
 816   {
 817     'key'         => 'deletecustomers',
 818     'section'     => 'UI',
 819     'description' => 'Enable customer deletions.  Be very careful!  Deleting a customer will remove all traces that the customer ever existed!  It should probably only be used when auditing a legacy database.  Normally, you cancel all of a customers\' packages if they cancel service.',
 820     'type'        => 'checkbox',
 821   },
 822
 823   {
 824     'key'         => 'deleteinvoices',
 825     'section'     => 'UI',
 826     'description' => 'Enable invoices deletions.  Be very careful!  Deleting an invoice will remove all traces that the invoice ever existed!  Normally, you would apply a credit against the invoice instead.',  #invoice voiding?
 827     'type'        => 'checkbox',
 828   },
 829
 830   {
 831     'key'         => 'deletepayments',
 832     'section'     => 'billing',
 833     'description' => 'Enable deletion of unclosed payments.  Really, with voids this is pretty much not recommended in any situation anymore.  Be very careful!  Only delete payments that were data-entry errors, not adjustments.  Optionally specify one or more comma-separated email addresses to be notified when a payment is deleted.',
 834     'type'        => [qw( checkbox text )],
 835   },
 836
 837   {
 838     'key'         => 'deletecredits',
 839     #not actually deprecated yet
 840     #'section'     => 'deprecated',
 841     #'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.',
 842     'section'     => '',
 843     'description' => 'One or more comma-separated email addresses to be notified when a credit is deleted.',
 844     'type'        => [qw( checkbox text )],
 845   },
 846
 847   {
 848     'key'         => 'deleterefunds',
 849     'section'     => 'billing',
 850     'description' => 'Enable deletion of unclosed refunds.  Be very careful!  Only delete refunds that were data-entry errors, not adjustments.',
 851     'type'        => 'checkbox',
 852   },
 853
 854   {
 855     'key'         => 'unapplypayments',
 856     'section'     => 'deprecated',
 857     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable "unapplication" of unclosed payments.',
 858     'type'        => 'checkbox',
 859   },
 860
 861   {
 862     'key'         => 'unapplycredits',
 863     'section'     => 'deprecated',
 864     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to nable "unapplication" of unclosed credits.',
 865     'type'        => 'checkbox',
 866   },
 867
 868   {
 869     'key'         => 'dirhash',
 870     'section'     => 'shell',
 871     '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>',
 872     'type'        => 'text',
 873   },
 874
 875   {
 876     'key'         => 'disable_cust_attachment',
 877     'section'     => '',
 878     'description' => 'Disable customer file attachments',
 879     'type'        => 'checkbox',
 880   },
 881
 882   {
 883     'key'         => 'max_attachment_size',
 884     'section'     => '',
 885     'description' => 'Maximum size for customer file attachments (leave blank for unlimited)',
 886     'type'        => 'text',
 887   },
 888
 889   {
 890     'key'         => 'disable_customer_referrals',
 891     'section'     => 'UI',
 892     'description' => 'Disable new customer-to-customer referrals in the web interface',
 893     'type'        => 'checkbox',
 894   },
 895
 896   {
 897     'key'         => 'editreferrals',
 898     'section'     => 'UI',
 899     'description' => 'Enable advertising source modification for existing customers',
 900     'type'        => 'checkbox',
 901   },
 902
 903   {
 904     'key'         => 'emailinvoiceonly',
 905     'section'     => 'invoicing',
 906     'description' => 'Disables postal mail invoices',
 907     'type'        => 'checkbox',
 908   },
 909
 910   {
 911     'key'         => 'disablepostalinvoicedefault',
 912     'section'     => 'invoicing',
 913     'description' => 'Disables postal mail invoices as the default option in the UI.  Be careful not to setup customers which are not sent invoices.  See <a href ="#emailinvoiceauto">emailinvoiceauto</a>.',
 914     'type'        => 'checkbox',
 915   },
 916
 917   {
 918     'key'         => 'emailinvoiceauto',
 919     'section'     => 'invoicing',
 920     'description' => 'Automatically adds new accounts to the email invoice list',
 921     'type'        => 'checkbox',
 922   },
 923
 924   {
 925     'key'         => 'emailinvoiceautoalways',
 926     'section'     => 'invoicing',
 927     'description' => 'Automatically adds new accounts to the email invoice list even when the list contains email addresses',
 928     'type'        => 'checkbox',
 929   },
 930
 931   {
 932     'key'         => 'emailinvoice-apostrophe',
 933     'section'     => 'invoicing',
 934     'description' => 'Allows the apostrophe (single quote) character in the email addresses in the email invoice list.',
 935     'type'        => 'checkbox',
 936   },
 937
 938   {
 939     'key'         => 'exclude_ip_addr',
 940     'section'     => '',
 941     'description' => 'Exclude these from the list of available broadband service IP addresses. (One per line)',
 942     'type'        => 'textarea',
 943   },
 944
 945   {
 946     'key'         => 'auto_router',
 947     'section'     => '',
 948     'description' => 'Automatically choose the correct router/block based on supplied ip address when possible while provisioning broadband services',
 949     'type'        => 'checkbox',
 950   },
 951
 952   {
 953     'key'         => 'hidecancelledpackages',
 954     'section'     => 'UI',
 955     'description' => 'Prevent cancelled packages from showing up in listings (though they will still be in the database)',
 956     'type'        => 'checkbox',
 957   },
 958
 959   {
 960     'key'         => 'hidecancelledcustomers',
 961     'section'     => 'UI',
 962     'description' => 'Prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
 963     'type'        => 'checkbox',
 964   },
 965
 966   {
 967     'key'         => 'home',
 968     'section'     => 'shell',
 969     'description' => 'For new users, prefixed to username to create a directory name.  Should have a leading but not a trailing slash.',
 970     'type'        => 'text',
 971   },
 972
 973   {
 974     'key'         => 'invoice_from',
 975     'section'     => 'required',
 976     'description' => 'Return address on email invoices',
 977     'type'        => 'text',
 978     'per_agent'   => 1,
 979   },
 980
 981   {
 982     'key'         => 'invoice_subject',
 983     'section'     => 'invoicing',
 984     'description' => 'Subject: header on email invoices.  Defaults to "Invoice".  The following substitutions are available: $name, $name_short, $invoice_number, and $invoice_date.',
 985     'type'        => 'text',
 986     'per_agent'   => 1,
 987   },
 988
 989   {
 990     'key'         => 'invoice_usesummary',
 991     'section'     => 'invoicing',
 992     'description' => 'Indicates that html and latex invoices should be in summary style and make use of invoice_latexsummary.',
 993     'type'        => 'checkbox',
 994   },
 995
 996   {
 997     'key'         => 'invoice_template',
 998     'section'     => 'invoicing',
 999     '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.',
1000     'type'        => 'textarea',
1001   },
1002
1003   {
1004     'key'         => 'invoice_html',
1005     'section'     => 'invoicing',
1006     'description' => 'Optional 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.',
1007
1008     'type'        => 'textarea',
1009   },
1010
1011   {
1012     'key'         => 'invoice_htmlnotes',
1013     'section'     => 'invoicing',
1014     'description' => 'Notes section for HTML invoices.  Defaults to the same data in invoice_latexnotes if not specified.',
1015     'type'        => 'textarea',
1016     'per_agent'   => 1,
1017   },
1018
1019   {
1020     'key'         => 'invoice_htmlfooter',
1021     'section'     => 'invoicing',
1022     'description' => 'Footer for HTML invoices.  Defaults to the same data in invoice_latexfooter if not specified.',
1023     'type'        => 'textarea',
1024     'per_agent'   => 1,
1025   },
1026
1027   {
1028     'key'         => 'invoice_htmlsummary',
1029     'section'     => 'invoicing',
1030     'description' => 'Summary initial page for HTML invoices.',
1031     'type'        => 'textarea',
1032     'per_agent'   => 1,
1033   },
1034
1035   {
1036     'key'         => 'invoice_htmlreturnaddress',
1037     'section'     => 'invoicing',
1038     'description' => 'Return address for HTML invoices.  Defaults to the same data in invoice_latexreturnaddress if not specified.',
1039     'type'        => 'textarea',
1040   },
1041
1042   {
1043     'key'         => 'invoice_latex',
1044     'section'     => 'invoicing',
1045     '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.',
1046     'type'        => 'textarea',
1047   },
1048
1049   {
1050     'key'         => 'invoice_latextopmargin',
1051     'section'     => 'invoicing',
1052     'description' => 'Optional LaTeX invoice topmargin setting. Include units.',
1053     'type'        => 'text',
1054     'per_agent'   => 1,
1055     'validate'    => sub { shift =~
1056                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1057                              ? '' : 'Invalid LaTex length';
1058                          },
1059   },
1060
1061   {
1062     'key'         => 'invoice_latexheadsep',
1063     'section'     => 'invoicing',
1064     'description' => 'Optional LaTeX invoice headsep setting. Include units.',
1065     'type'        => 'text',
1066     'per_agent'   => 1,
1067     'validate'    => sub { shift =~
1068                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1069                              ? '' : 'Invalid LaTex length';
1070                          },
1071   },
1072
1073   {
1074     'key'         => 'invoice_latexaddresssep',
1075     'section'     => 'invoicing',
1076     'description' => 'Optional LaTeX invoice separation between invoice header
1077 and customer address. Include units.',
1078     'type'        => 'text',
1079     'per_agent'   => 1,
1080     'validate'    => sub { shift =~
1081                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1082                              ? '' : 'Invalid LaTex length';
1083                          },
1084   },
1085
1086   {
1087     'key'         => 'invoice_latextextheight',
1088     'section'     => 'invoicing',
1089     'description' => 'Optional LaTeX invoice textheight setting. Include units.',
1090     'type'        => 'text',
1091     'per_agent'   => 1,
1092     'validate'    => sub { shift =~
1093                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1094                              ? '' : 'Invalid LaTex length';
1095                          },
1096   },
1097
1098   {
1099     'key'         => 'invoice_latexnotes',
1100     'section'     => 'invoicing',
1101     'description' => 'Notes section for LaTeX typeset PostScript invoices.',
1102     'type'        => 'textarea',
1103     'per_agent'   => 1,
1104   },
1105
1106   {
1107     'key'         => 'invoice_latexfooter',
1108     'section'     => 'invoicing',
1109     'description' => 'Footer for LaTeX typeset PostScript invoices.',
1110     'type'        => 'textarea',
1111     'per_agent'   => 1,
1112   },
1113
1114   {
1115     'key'         => 'invoice_latexsummary',
1116     'section'     => 'invoicing',
1117     'description' => 'Summary initial page for LaTeX typeset PostScript invoices.',
1118     'type'        => 'textarea',
1119     'per_agent'   => 1,
1120   },
1121
1122   {
1123     'key'         => 'invoice_latexcoupon',
1124     'section'     => 'invoicing',
1125     'description' => 'Remittance coupon for LaTeX typeset PostScript invoices.',
1126     'type'        => 'textarea',
1127     'per_agent'   => 1,
1128   },
1129
1130   {
1131     'key'         => 'invoice_latexextracouponspace',
1132     'section'     => 'invoicing',
1133     'description' => 'Optional LaTeX invoice textheight space to reserve for a tear off coupon. Include units.',
1134     'type'        => 'text',
1135     'per_agent'   => 1,
1136     'validate'    => sub { shift =~
1137                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1138                              ? '' : 'Invalid LaTex length';
1139                          },
1140   },
1141
1142   {
1143     'key'         => 'invoice_latexcouponfootsep',
1144     'section'     => 'invoicing',
1145     'description' => 'Optional LaTeX invoice separation between tear off coupon and footer. Include units.',
1146     'type'        => 'text',
1147     'per_agent'   => 1,
1148     'validate'    => sub { shift =~
1149                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1150                              ? '' : 'Invalid LaTex length';
1151                          },
1152   },
1153
1154   {
1155     'key'         => 'invoice_latexcouponamountenclosedsep',
1156     'section'     => 'invoicing',
1157     'description' => 'Optional LaTeX invoice separation between total due and amount enclosed line. Include units.',
1158     'type'        => 'text',
1159     'per_agent'   => 1,
1160     'validate'    => sub { shift =~
1161                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1162                              ? '' : 'Invalid LaTex length';
1163                          },
1164   },
1165   {
1166     'key'         => 'invoice_latexcoupontoaddresssep',
1167     'section'     => 'invoicing',
1168     'description' => 'Optional LaTeX invoice separation between invoice data and the to address (usually invoice_latexreturnaddress).  Include units.',
1169     'type'        => 'text',
1170     'per_agent'   => 1,
1171     'validate'    => sub { shift =~
1172                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1173                              ? '' : 'Invalid LaTex length';
1174                          },
1175   },
1176
1177   {
1178     'key'         => 'invoice_latexreturnaddress',
1179     'section'     => 'invoicing',
1180     'description' => 'Return address for LaTeX typeset PostScript invoices.',
1181     'type'        => 'textarea',
1182   },
1183
1184   {
1185     'key'         => 'invoice_latexverticalreturnaddress',
1186     'section'     => 'invoicing',
1187     'description' => 'Place the return address under the company logo rather than beside it.',
1188     'type'        => 'checkbox',
1189     'per_agent'   => 1,
1190   },
1191
1192   {
1193     'key'         => 'invoice_latexcouponaddcompanytoaddress',
1194     'section'     => 'invoicing',
1195     'description' => 'Add the company name to the To address on the remittance coupon because the return address does not contain it.',
1196     'type'        => 'checkbox',
1197     'per_agent'   => 1,
1198   },
1199
1200   {
1201     'key'         => 'invoice_latexsmallfooter',
1202     'section'     => 'invoicing',
1203     'description' => 'Optional small footer for multi-page LaTeX typeset PostScript invoices.',
1204     'type'        => 'textarea',
1205     'per_agent'   => 1,
1206   },
1207
1208   {
1209     'key'         => 'invoice_email_pdf',
1210     'section'     => 'invoicing',
1211     '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.',
1212     'type'        => 'checkbox'
1213   },
1214
1215   {
1216     'key'         => 'invoice_email_pdf_note',
1217     'section'     => 'invoicing',
1218     'description' => 'If defined, this text will replace the default plain text invoice as the body of emailed PDF invoices.',
1219     'type'        => 'textarea'
1220   },
1221
1222   {
1223     'key'         => 'invoice_print_pdf',
1224     'section'     => 'invoicing',
1225     'description' => 'Store postal invoices for download in PDF format rather than printing them directly.',
1226     'type'        => 'checkbox',
1227   },
1228
1229   {
1230     'key'         => 'invoice_default_terms',
1231     'section'     => 'invoicing',
1232     'description' => 'Optional default invoice term, used to calculate a due date printed on invoices.',
1233     'type'        => 'select',
1234     'select_enum' => [ '', 'Payable upon receipt', 'Net 0', 'Net 3', 'Net 10', 'Net 15', 'Net 20', 'Net 21', 'Net 30', 'Net 45', 'Net 60', 'Net 90' ],
1235   },
1236
1237   {
1238     'key'         => 'invoice_show_prior_due_date',
1239     'section'     => 'invoicing',
1240     'description' => 'Show previous invoice due dates when showing prior balances.  Default is to show invoice date.',
1241     'type'        => 'checkbox',
1242   },
1243
1244   {
1245     'key'         => 'invoice_include_aging',
1246     'section'     => 'invoicing',
1247     'description' => 'Show an aging line after the prior balance section.  Only valud when invoice_sections is enabled.',
1248     'type'        => 'checkbox',
1249   },
1250
1251   {
1252     'key'         => 'invoice_sections',
1253     'section'     => 'invoicing',
1254     'description' => 'Split invoice into sections and label according to package category when enabled.',
1255     'type'        => 'checkbox',
1256   },
1257
1258   {
1259     'key'         => 'usage_class_as_a_section',
1260     'section'     => 'invoicing',
1261     'description' => 'Split usage into sections and label according to usage class name when enabled.  Only valid when invoice_sections is enabled.',
1262     'type'        => 'checkbox',
1263   },
1264
1265   {
1266     'key'         => 'svc_phone_sections',
1267     'section'     => 'invoicing',
1268     'description' => 'Create a section for each svc_phone when enabled.  Only valid when invoice_sections is enabled.',
1269     'type'        => 'checkbox',
1270   },
1271
1272   {
1273     'key'         => 'finance_pkgclass',
1274     'section'     => 'billing',
1275     'description' => 'The default package class for late fee charges, used if the fee event does not specify a package class itself.',
1276     'type'        => 'select-pkg_class',
1277   },
1278
1279   {
1280     'key'         => 'separate_usage',
1281     'section'     => 'invoicing',
1282     'description' => 'Split the rated call usage into a separate line from the recurring charges.',
1283     'type'        => 'checkbox',
1284   },
1285
1286   {
1287     'key'         => 'invoice_send_receipts',
1288     'section'     => 'deprecated',
1289     'description' => '<b>DEPRECATED</b>, this used to send an invoice copy on payments and credits.  See the payment_receipt_email and XXXX instead.',
1290     'type'        => 'checkbox',
1291   },
1292
1293   {
1294     'key'         => 'payment_receipt',
1295     'section'     => 'notification',
1296     'description' => 'Send payment receipts.',
1297     'type'        => 'checkbox',
1298     'per_agent'   => 1,
1299   },
1300
1301   {
1302     'key'         => 'payment_receipt_msgnum',
1303     'section'     => 'notification',
1304     'description' => 'Template to use for payment receipts.',
1305     %msg_template_options,
1306   },
1307
1308   {
1309     'key'         => 'payment_receipt_email',
1310     'section'     => 'deprecated',
1311     'description' => 'Template file for payment receipts.  Payment receipts are sent to the customer email invoice destination(s) when a payment is received.',
1312     'type'        => [qw( checkbox textarea )],
1313   },
1314
1315   {
1316     'key'         => 'payment_receipt-trigger',
1317     'section'     => 'notification',
1318     'description' => 'When payment receipts are triggered.  Defaults to when payment is made.',
1319     'type'        => 'select',
1320     'select_hash' => [
1321                        'cust_pay'          => 'When payment is made.',
1322                        'cust_bill_pay_pkg' => 'When payment is applied.',
1323                      ],
1324     'per_agent'   => 1,
1325   },
1326
1327   {
1328     'key'         => 'trigger_export_insert_on_payment',
1329     'section'     => 'billing',
1330     'description' => 'Enable exports on payment application.',
1331     'type'        => 'checkbox',
1332   },
1333
1334   {
1335     'key'         => 'lpr',
1336     'section'     => 'required',
1337     'description' => 'Print command for paper invoices, for example `lpr -h\'',
1338     'type'        => 'text',
1339   },
1340
1341   {
1342     'key'         => 'lpr-postscript_prefix',
1343     'section'     => 'billing',
1344     'description' => 'Raw printer commands prepended to the beginning of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1345     'type'        => 'text',
1346   },
1347
1348   {
1349     'key'         => 'lpr-postscript_suffix',
1350     'section'     => 'billing',
1351     'description' => 'Raw printer commands added to the end of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1352     'type'        => 'text',
1353   },
1354
1355   {
1356     'key'         => 'money_char',
1357     'section'     => '',
1358     'description' => 'Currency symbol - defaults to `$\'',
1359     'type'        => 'text',
1360   },
1361
1362   {
1363     'key'         => 'defaultrecords',
1364     'section'     => 'BIND',
1365     'description' => 'DNS entries to add automatically when creating a domain',
1366     'type'        => 'editlist',
1367     'editlist_parts' => [ { type=>'text' },
1368                           { type=>'immutable', value=>'IN' },
1369                           { type=>'select',
1370                             select_enum => {
1371                               map { $_=>$_ }
1372                                   #@{ FS::domain_record->rectypes }
1373                                   qw(A AAAA CNAME MX NS PTR SPF SRV TXT)
1374                             },
1375                           },
1376                           { type=> 'text' }, ],
1377   },
1378
1379   {
1380     'key'         => 'passwordmin',
1381     'section'     => 'password',
1382     'description' => 'Minimum password length (default 6)',
1383     'type'        => 'text',
1384   },
1385
1386   {
1387     'key'         => 'passwordmax',
1388     'section'     => 'password',
1389     'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
1390     'type'        => 'text',
1391   },
1392
1393   {
1394     'key'         => 'password-noampersand',
1395     'section'     => 'password',
1396     'description' => 'Disallow ampersands in passwords',
1397     'type'        => 'checkbox',
1398   },
1399
1400   {
1401     'key'         => 'password-noexclamation',
1402     'section'     => 'password',
1403     'description' => 'Disallow exclamations in passwords (Not setting this could break old text Livingston or Cistron Radius servers)',
1404     'type'        => 'checkbox',
1405   },
1406
1407   {
1408     'key'         => 'default-password-encoding',
1409     'section'     => 'password',
1410     'description' => 'Default storage format for passwords',
1411     'type'        => 'select',
1412     'select_hash' => [
1413       'plain'       => 'Plain text',
1414       'crypt-des'   => 'Unix password (DES encrypted)',
1415       'crypt-md5'   => 'Unix password (MD5 digest)',
1416       'ldap-plain'  => 'LDAP (plain text)',
1417       'ldap-crypt'  => 'LDAP (DES encrypted)',
1418       'ldap-md5'    => 'LDAP (MD5 digest)',
1419       'ldap-sha1'   => 'LDAP (SHA1 digest)',
1420       'legacy'      => 'Legacy mode',
1421     ],
1422   },
1423
1424   {
1425     'key'         => 'referraldefault',
1426     'section'     => 'UI',
1427     'description' => 'Default referral, specified by refnum',
1428     'type'        => 'select-sub',
1429     'options_sub' => sub { require FS::Record;
1430                            require FS::part_referral;
1431                            map { $_->refnum => $_->referral }
1432                                FS::Record::qsearch( 'part_referral',
1433                                                     { 'disabled' => '' }
1434                                                   );
1435                          },
1436     'option_sub'  => sub { require FS::Record;
1437                            require FS::part_referral;
1438                            my $part_referral = FS::Record::qsearchs(
1439                              'part_referral', { 'refnum'=>shift } );
1440                            $part_referral ? $part_referral->referral : '';
1441                          },
1442   },
1443
1444 #  {
1445 #    'key'         => 'registries',
1446 #    'section'     => 'required',
1447 #    'description' => 'Directory which contains domain registry information.  Each registry is a directory.',
1448 #  },
1449
1450   {
1451     'key'         => 'report_template',
1452     'section'     => 'deprecated',
1453     'description' => 'Deprecated template file for reports.',
1454     'type'        => 'textarea',
1455   },
1456
1457   {
1458     'key'         => 'maxsearchrecordsperpage',
1459     'section'     => 'UI',
1460     'description' => 'If set, number of search records to return per page.',
1461     'type'        => 'text',
1462   },
1463
1464   {
1465     'key'         => 'session-start',
1466     'section'     => 'session',
1467     '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.',
1468     'type'        => 'text',
1469   },
1470
1471   {
1472     'key'         => 'session-stop',
1473     'section'     => 'session',
1474     '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.',
1475     'type'        => 'text',
1476   },
1477
1478   {
1479     'key'         => 'shells',
1480     'section'     => 'shell',
1481     'description' => 'Legal shells (think /etc/shells).  You probably want to `cut -d: -f7 /etc/passwd | sort | uniq\' initially so that importing doesn\'t fail with `Illegal shell\' errors, then remove any special entries afterwords.  A blank line specifies that an empty shell is permitted.',
1482     'type'        => 'textarea',
1483   },
1484
1485   {
1486     'key'         => 'showpasswords',
1487     'section'     => 'UI',
1488     'description' => 'Display unencrypted user passwords in the backend (employee) web interface',
1489     'type'        => 'checkbox',
1490   },
1491
1492   {
1493     'key'         => 'report-showpasswords',
1494     'section'     => 'UI',
1495     'description' => 'This is a terrible idea.  Do not enable it.  STRONGLY NOT RECOMMENDED.  Enables display of passwords on services reports.',
1496     'type'        => 'checkbox',
1497   },
1498
1499   {
1500     'key'         => 'signupurl',
1501     'section'     => 'UI',
1502     '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',
1503     'type'        => 'text',
1504   },
1505
1506   {
1507     'key'         => 'smtpmachine',
1508     'section'     => 'required',
1509     'description' => 'SMTP relay for Freeside\'s outgoing mail',
1510     'type'        => 'text',
1511   },
1512
1513   {
1514     'key'         => 'smtp-username',
1515     'section'     => '',
1516     'description' => 'Optional SMTP username for Freeside\'s outgoing mail',
1517     'type'        => 'text',
1518   },
1519
1520   {
1521     'key'         => 'smtp-password',
1522     'section'     => '',
1523     'description' => 'Optional SMTP password for Freeside\'s outgoing mail',
1524     'type'        => 'text',
1525   },
1526
1527   {
1528     'key'         => 'smtp-encryption',
1529     'section'     => '',
1530     'description' => 'Optional SMTP encryption method.  The STARTTLS methods require smtp-username and smtp-password to be set.',
1531     'type'        => 'select',
1532     'select_hash' => [ '25'           => 'None (port 25)',
1533                        '25-starttls'  => 'STARTTLS (port 25)',
1534                        '587-starttls' => 'STARTTLS / submission (port 587)',
1535                        '465-tls'      => 'SMTPS (SSL) (port 465)',
1536                      ],
1537   },
1538
1539   {
1540     'key'         => 'soadefaultttl',
1541     'section'     => 'BIND',
1542     'description' => 'SOA default TTL for new domains.',
1543     'type'        => 'text',
1544   },
1545
1546   {
1547     'key'         => 'soaemail',
1548     'section'     => 'BIND',
1549     'description' => 'SOA email for new domains, in BIND form (`.\' instead of `@\'), with trailing `.\'',
1550     'type'        => 'text',
1551   },
1552
1553   {
1554     'key'         => 'soaexpire',
1555     'section'     => 'BIND',
1556     'description' => 'SOA expire for new domains',
1557     'type'        => 'text',
1558   },
1559
1560   {
1561     'key'         => 'soamachine',
1562     'section'     => 'BIND',
1563     'description' => 'SOA machine for new domains, with trailing `.\'',
1564     'type'        => 'text',
1565   },
1566
1567   {
1568     'key'         => 'soarefresh',
1569     'section'     => 'BIND',
1570     'description' => 'SOA refresh for new domains',
1571     'type'        => 'text',
1572   },
1573
1574   {
1575     'key'         => 'soaretry',
1576     'section'     => 'BIND',
1577     'description' => 'SOA retry for new domains',
1578     'type'        => 'text',
1579   },
1580
1581   {
1582     'key'         => 'statedefault',
1583     'section'     => 'UI',
1584     'description' => 'Default state or province (if not supplied, the default is `CA\')',
1585     'type'        => 'text',
1586   },
1587
1588   {
1589     'key'         => 'unsuspendauto',
1590     'section'     => 'billing',
1591     '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',
1592     'type'        => 'checkbox',
1593   },
1594
1595   {
1596     'key'         => 'unsuspend-always_adjust_next_bill_date',
1597     'section'     => 'billing',
1598     '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.',
1599     'type'        => 'checkbox',
1600   },
1601
1602   {
1603     'key'         => 'usernamemin',
1604     'section'     => 'username',
1605     'description' => 'Minimum username length (default 2)',
1606     'type'        => 'text',
1607   },
1608
1609   {
1610     'key'         => 'usernamemax',
1611     'section'     => 'username',
1612     'description' => 'Maximum username length',
1613     'type'        => 'text',
1614   },
1615
1616   {
1617     'key'         => 'username-ampersand',
1618     'section'     => 'username',
1619     'description' => 'Allow the ampersand character (&amp;) in usernames.  Be careful when using this option in conjunction with <a href="../browse/part_export.cgi">exports</a> which execute shell commands, as the ampersand will be interpreted by the shell if not quoted.',
1620     'type'        => 'checkbox',
1621   },
1622
1623   {
1624     'key'         => 'username-letter',
1625     'section'     => 'username',
1626     'description' => 'Usernames must contain at least one letter',
1627     'type'        => 'checkbox',
1628     'per_agent'   => 1,
1629   },
1630
1631   {
1632     'key'         => 'username-letterfirst',
1633     'section'     => 'username',
1634     'description' => 'Usernames must start with a letter',
1635     'type'        => 'checkbox',
1636   },
1637
1638   {
1639     'key'         => 'username-noperiod',
1640     'section'     => 'username',
1641     'description' => 'Disallow periods in usernames',
1642     'type'        => 'checkbox',
1643   },
1644
1645   {
1646     'key'         => 'username-nounderscore',
1647     'section'     => 'username',
1648     'description' => 'Disallow underscores in usernames',
1649     'type'        => 'checkbox',
1650   },
1651
1652   {
1653     'key'         => 'username-nodash',
1654     'section'     => 'username',
1655     'description' => 'Disallow dashes in usernames',
1656     'type'        => 'checkbox',
1657   },
1658
1659   {
1660     'key'         => 'username-uppercase',
1661     'section'     => 'username',
1662     'description' => 'Allow uppercase characters in usernames.  Not recommended for use with FreeRADIUS with MySQL backend, which is case-insensitive by default.',
1663     'type'        => 'checkbox',
1664   },
1665
1666   {
1667     'key'         => 'username-percent',
1668     'section'     => 'username',
1669     'description' => 'Allow the percent character (%) in usernames.',
1670     'type'        => 'checkbox',
1671   },
1672
1673   {
1674     'key'         => 'username-colon',
1675     'section'     => 'username',
1676     'description' => 'Allow the colon character (:) in usernames.',
1677     'type'        => 'checkbox',
1678   },
1679
1680   {
1681     'key'         => 'username-slash',
1682     'section'     => 'username',
1683     'description' => 'Allow the slash character (/) in usernames.  When using, make sure to set "Home directory" to fixed and blank in all svc_acct service definitions.',
1684     'type'        => 'checkbox',
1685   },
1686
1687   {
1688     'key'         => 'username-equals',
1689     'section'     => 'username',
1690     'description' => 'Allow the equal sign character (=) in usernames.',
1691     'type'        => 'checkbox',
1692   },
1693
1694   {
1695     'key'         => 'safe-part_bill_event',
1696     'section'     => 'UI',
1697     'description' => 'Validates invoice event expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
1698     'type'        => 'checkbox',
1699   },
1700
1701   {
1702     'key'         => 'show_ss',
1703     'section'     => 'UI',
1704     'description' => 'Turns on display/collection of social security numbers in the web interface.  Sometimes required by electronic check (ACH) processors.',
1705     'type'        => 'checkbox',
1706   },
1707
1708   {
1709     'key'         => 'show_stateid',
1710     'section'     => 'UI',
1711     'description' => "Turns on display/collection of driver's license/state issued id numbers in the web interface.  Sometimes required by electronic check (ACH) processors.",
1712     'type'        => 'checkbox',
1713   },
1714
1715   {
1716     'key'         => 'show_bankstate',
1717     'section'     => 'UI',
1718     'description' => "Turns on display/collection of state for bank accounts in the web interface.  Sometimes required by electronic check (ACH) processors.",
1719     'type'        => 'checkbox',
1720   },
1721
1722   {
1723     'key'         => 'agent_defaultpkg',
1724     'section'     => 'UI',
1725     'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
1726     'type'        => 'checkbox',
1727   },
1728
1729   {
1730     'key'         => 'legacy_link',
1731     'section'     => 'UI',
1732     'description' => 'Display options in the web interface to link legacy pre-Freeside services.',
1733     'type'        => 'checkbox',
1734   },
1735
1736   {
1737     'key'         => 'legacy_link-steal',
1738     'section'     => 'UI',
1739     'description' => 'Allow "stealing" an already-audited service from one customer (or package) to another using the link function.',
1740     'type'        => 'checkbox',
1741   },
1742
1743   {
1744     'key'         => 'queue_dangerous_controls',
1745     'section'     => 'UI',
1746     '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.',
1747     'type'        => 'checkbox',
1748   },
1749
1750   {
1751     'key'         => 'security_phrase',
1752     'section'     => 'password',
1753     'description' => 'Enable the tracking of a "security phrase" with each account.  Not recommended, as it is vulnerable to social engineering.',
1754     'type'        => 'checkbox',
1755   },
1756
1757   {
1758     'key'         => 'locale',
1759     'section'     => 'UI',
1760     'description' => 'Message locale',
1761     'type'        => 'select',
1762     'select_enum' => [ qw(en_US) ],
1763   },
1764
1765   {
1766     'key'         => 'signup_server-payby',
1767     'section'     => 'self-service',
1768     'description' => 'Acceptable payment types for the signup server',
1769     'type'        => 'selectmultiple',
1770     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB PREPAY BILL COMP) ],
1771   },
1772
1773   {
1774     'key'         => 'selfservice-payment_gateway',
1775     'section'     => 'self-service',
1776     'description' => 'Force the use of this payment gateway for self-service.',
1777     %payment_gateway_options,
1778   },
1779
1780   {
1781     'key'         => 'selfservice-save_unchecked',
1782     'section'     => 'self-service',
1783     'description' => 'In self-service, uncheck "Remember information" checkboxes by default (normally, they are checked by default).',
1784     'type'        => 'checkbox',
1785   },
1786
1787   {
1788     'key'         => 'signup_server-default_agentnum',
1789     'section'     => 'self-service',
1790     'description' => 'Default agent for the signup server',
1791     'type'        => 'select-sub',
1792     'options_sub' => sub { require FS::Record;
1793                            require FS::agent;
1794                            map { $_->agentnum => $_->agent }
1795                                FS::Record::qsearch('agent', { disabled=>'' } );
1796                          },
1797     'option_sub'  => sub { require FS::Record;
1798                            require FS::agent;
1799                            my $agent = FS::Record::qsearchs(
1800                              'agent', { 'agentnum'=>shift }
1801                            );
1802                            $agent ? $agent->agent : '';
1803                          },
1804   },
1805
1806   {
1807     'key'         => 'signup_server-default_refnum',
1808     'section'     => 'self-service',
1809     'description' => 'Default advertising source for the signup server',
1810     'type'        => 'select-sub',
1811     'options_sub' => sub { require FS::Record;
1812                            require FS::part_referral;
1813                            map { $_->refnum => $_->referral }
1814                                FS::Record::qsearch( 'part_referral',
1815                                                     { 'disabled' => '' }
1816                                                   );
1817                          },
1818     'option_sub'  => sub { require FS::Record;
1819                            require FS::part_referral;
1820                            my $part_referral = FS::Record::qsearchs(
1821                              'part_referral', { 'refnum'=>shift } );
1822                            $part_referral ? $part_referral->referral : '';
1823                          },
1824   },
1825
1826   {
1827     'key'         => 'signup_server-default_pkgpart',
1828     'section'     => 'self-service',
1829     'description' => 'Default package for the signup server',
1830     'type'        => 'select-part_pkg',
1831   },
1832
1833   {
1834     'key'         => 'signup_server-default_svcpart',
1835     'section'     => 'self-service',
1836     'description' => 'Default service definition for the signup server - only necessary for services that trigger special provisioning widgets (such as DID provisioning).',
1837     'type'        => 'select-part_svc',
1838   },
1839
1840   {
1841     'key'         => 'signup_server-mac_addr_svcparts',
1842     'section'     => 'self-service',
1843     'description' => 'Service definitions which can receive mac addresses (current mapped to username for svc_acct).',
1844     'type'        => 'select-part_svc',
1845     'multiple'    => 1,
1846   },
1847
1848   {
1849     'key'         => 'signup_server-nomadix',
1850     'section'     => 'self-service',
1851     'description' => 'Signup page Nomadix integration',
1852     'type'        => 'checkbox',
1853   },
1854
1855   {
1856     'key'         => 'signup_server-service',
1857     'section'     => 'self-service',
1858     'description' => 'Service for the signup server - "Account (svc_acct)" is the default setting, or "Phone number (svc_phone)" for ITSP signup',
1859     'type'        => 'select',
1860     'select_hash' => [
1861                        'svc_acct'  => 'Account (svc_acct)',
1862                        'svc_phone' => 'Phone number (svc_phone)',
1863                        'svc_pbx'   => 'PBX (svc_pbx)',
1864                      ],
1865   },
1866
1867   {
1868     'key'         => 'signup_server-prepaid-template-custnum',
1869     'section'     => 'self-service',
1870     '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',
1871     'type'        => 'text',
1872   },
1873
1874   {
1875     'key'         => 'selfservice_server-base_url',
1876     'section'     => 'self-service',
1877     'description' => 'Base URL for the self-service web interface - necessary for some widgets to find their way, including retrieval of non-US state information and phone number provisioning.',
1878     'type'        => 'text',
1879   },
1880
1881   {
1882     'key'         => 'show-msgcat-codes',
1883     'section'     => 'UI',
1884     'description' => 'Show msgcat codes in error messages.  Turn this option on before reporting errors to the mailing list.',
1885     'type'        => 'checkbox',
1886   },
1887
1888   {
1889     'key'         => 'signup_server-realtime',
1890     'section'     => 'self-service',
1891     'description' => 'Run billing for signup server signups immediately, and do not provision accounts which subsequently have a balance.',
1892     'type'        => 'checkbox',
1893   },
1894
1895   {
1896     'key'         => 'signup_server-classnum2',
1897     'section'     => 'self-service',
1898     'description' => 'Package Class for first optional purchase',
1899     'type'        => 'select-pkg_class',
1900   },
1901
1902   {
1903     'key'         => 'signup_server-classnum3',
1904     'section'     => 'self-service',
1905     'description' => 'Package Class for second optional purchase',
1906     'type'        => 'select-pkg_class',
1907   },
1908
1909   {
1910     'key'         => 'selfservice-xmlrpc',
1911     'section'     => 'self-service',
1912     'description' => 'Run a standalone self-service XML-RPC server on the backend (on port 8080).',
1913     'type'        => 'checkbox',
1914   },
1915
1916   {
1917     'key'         => 'backend-realtime',
1918     'section'     => 'billing',
1919     'description' => 'Run billing for backend signups immediately.',
1920     'type'        => 'checkbox',
1921   },
1922
1923   {
1924     'key'         => 'decline_msgnum',
1925     'section'     => 'notification',
1926     'description' => 'Template to use for credit card and electronic check decline messages.',
1927     %msg_template_options,
1928   },
1929
1930   {
1931     'key'         => 'declinetemplate',
1932     'section'     => 'deprecated',
1933     'description' => 'Template file for credit card and electronic check decline emails.',
1934     'type'        => 'textarea',
1935   },
1936
1937   {
1938     'key'         => 'emaildecline',
1939     'section'     => 'notification',
1940     'description' => 'Enable emailing of credit card and electronic check decline notices.',
1941     'type'        => 'checkbox',
1942     'per_agent'   => 1,
1943   },
1944
1945   {
1946     'key'         => 'emaildecline-exclude',
1947     'section'     => 'notification',
1948     'description' => 'List of error messages that should not trigger email decline notices, one per line.',
1949     'type'        => 'textarea',
1950     'per_agent'   => 1,
1951   },
1952
1953   {
1954     'key'         => 'cancel_msgnum',
1955     'section'     => 'notification',
1956     'description' => 'Template to use for cancellation emails.',
1957     %msg_template_options,
1958   },
1959
1960   {
1961     'key'         => 'cancelmessage',
1962     'section'     => 'deprecated',
1963     'description' => 'Template file for cancellation emails.',
1964     'type'        => 'textarea',
1965   },
1966
1967   {
1968     'key'         => 'cancelsubject',
1969     'section'     => 'deprecated',
1970     'description' => 'Subject line for cancellation emails.',
1971     'type'        => 'text',
1972   },
1973
1974   {
1975     'key'         => 'emailcancel',
1976     'section'     => 'notification',
1977     'description' => 'Enable emailing of cancellation notices.  Make sure to select the template in the cancel_msgnum option.',
1978     'type'        => 'checkbox',
1979     'per_agent'   => 1,
1980   },
1981
1982   {
1983     'key'         => 'bill_usage_on_cancel',
1984     'section'     => 'billing',
1985     '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.',
1986     'type'        => 'checkbox',
1987   },
1988
1989   {
1990     'key'         => 'require_cardname',
1991     'section'     => 'billing',
1992     'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
1993     'type'        => 'checkbox',
1994   },
1995
1996   {
1997     'key'         => 'enable_taxclasses',
1998     'section'     => 'billing',
1999     'description' => 'Enable per-package tax classes',
2000     'type'        => 'checkbox',
2001   },
2002
2003   {
2004     'key'         => 'require_taxclasses',
2005     'section'     => 'billing',
2006     'description' => 'Require a taxclass to be entered for every package',
2007     'type'        => 'checkbox',
2008   },
2009
2010   {
2011     'key'         => 'enable_taxproducts',
2012     'section'     => 'billing',
2013     'description' => 'Enable per-package mapping to vendor tax data from CCH or elsewhere.',
2014     'type'        => 'checkbox',
2015   },
2016
2017   {
2018     'key'         => 'taxdatadirectdownload',
2019     'section'     => 'billing',  #well
2020     'description' => 'Enable downloading tax data directly from the vendor site. at least three lines: URL, username, and password.j',
2021     'type'        => 'textarea',
2022   },
2023
2024   {
2025     'key'         => 'ignore_incalculable_taxes',
2026     'section'     => 'billing',
2027     'description' => 'Prefer to invoice without tax over not billing at all',
2028     'type'        => 'checkbox',
2029   },
2030
2031   {
2032     'key'         => 'welcome_msgnum',
2033     'section'     => 'notification',
2034     'description' => 'Template to use for welcome messages when a svc_acct record is created.',
2035     %msg_template_options,
2036   },
2037
2038   {
2039     'key'         => 'welcome_email',
2040     'section'     => 'deprecated',
2041     '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.',
2042     'type'        => 'textarea',
2043     'per_agent'   => 1,
2044   },
2045
2046   {
2047     'key'         => 'welcome_email-from',
2048     'section'     => 'deprecated',
2049     'description' => 'From: address header for welcome email',
2050     'type'        => 'text',
2051     'per_agent'   => 1,
2052   },
2053
2054   {
2055     'key'         => 'welcome_email-subject',
2056     'section'     => 'deprecated',
2057     'description' => 'Subject: header for welcome email',
2058     'type'        => 'text',
2059     'per_agent'   => 1,
2060   },
2061
2062   {
2063     'key'         => 'welcome_email-mimetype',
2064     'section'     => 'deprecated',
2065     'description' => 'MIME type for welcome email',
2066     'type'        => 'select',
2067     'select_enum' => [ 'text/plain', 'text/html' ],
2068     'per_agent'   => 1,
2069   },
2070
2071   {
2072     'key'         => 'welcome_letter',
2073     'section'     => '',
2074     '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>',
2075     'type'        => 'textarea',
2076   },
2077
2078 #  {
2079 #    'key'         => 'warning_msgnum',
2080 #    'section'     => 'notification',
2081 #    '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.',
2082 #    %msg_template_options,
2083 #  },
2084
2085   {
2086     'key'         => 'warning_email',
2087     'section'     => 'notification',
2088     '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>',
2089     'type'        => 'textarea',
2090   },
2091
2092   {
2093     'key'         => 'warning_email-from',
2094     'section'     => 'notification',
2095     'description' => 'From: address header for warning email',
2096     'type'        => 'text',
2097   },
2098
2099   {
2100     'key'         => 'warning_email-cc',
2101     'section'     => 'notification',
2102     'description' => 'Additional recipient(s) (comma separated) for warning email when remaining usage reaches zero.',
2103     'type'        => 'text',
2104   },
2105
2106   {
2107     'key'         => 'warning_email-subject',
2108     'section'     => 'notification',
2109     'description' => 'Subject: header for warning email',
2110     'type'        => 'text',
2111   },
2112
2113   {
2114     'key'         => 'warning_email-mimetype',
2115     'section'     => 'notification',
2116     'description' => 'MIME type for warning email',
2117     'type'        => 'select',
2118     'select_enum' => [ 'text/plain', 'text/html' ],
2119   },
2120
2121   {
2122     'key'         => 'payby',
2123     'section'     => 'billing',
2124     'description' => 'Available payment types.',
2125     'type'        => 'selectmultiple',
2126     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP) ],
2127   },
2128
2129   {
2130     'key'         => 'payby-default',
2131     'section'     => 'UI',
2132     'description' => 'Default payment type.  HIDE disables display of billing information and sets customers to BILL.',
2133     'type'        => 'select',
2134     'select_enum' => [ '', qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP HIDE) ],
2135   },
2136
2137   {
2138     'key'         => 'paymentforcedtobatch',
2139     'section'     => 'deprecated',
2140     '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.',
2141     'type'        => 'checkbox',
2142   },
2143
2144   {
2145     'key'         => 'svc_acct-notes',
2146     'section'     => 'deprecated',
2147     'description' => 'Extra HTML to be displayed on the Account View screen.',
2148     'type'        => 'textarea',
2149   },
2150
2151   {
2152     'key'         => 'radius-password',
2153     'section'     => '',
2154     'description' => 'RADIUS attribute for plain-text passwords.',
2155     'type'        => 'select',
2156     'select_enum' => [ 'Password', 'User-Password', 'Cleartext-Password' ],
2157   },
2158
2159   {
2160     'key'         => 'radius-ip',
2161     'section'     => '',
2162     'description' => 'RADIUS attribute for IP addresses.',
2163     'type'        => 'select',
2164     'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
2165   },
2166
2167   #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
2168   {
2169     'key'         => 'radius-chillispot-max',
2170     'section'     => '',
2171     'description' => 'Enable ChilliSpot (and CoovaChilli) Max attributes, specifically ChilliSpot-Max-{Input,Output,Total}-{Octets,Gigawords}.',
2172     'type'        => 'checkbox',
2173   },
2174
2175   {
2176     'key'         => 'svc_acct-alldomains',
2177     'section'     => '',
2178     '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.',
2179     'type'        => 'checkbox',
2180   },
2181
2182   {
2183     'key'         => 'dump-scpdest',
2184     'section'     => '',
2185     'description' => 'destination for scp database dumps: user@host:/path',
2186     'type'        => 'text',
2187   },
2188
2189   {
2190     'key'         => 'dump-pgpid',
2191     'section'     => '',
2192     '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.",
2193     'type'        => 'text',
2194   },
2195
2196   {
2197     'key'         => 'users-allow_comp',
2198     'section'     => 'deprecated',
2199     '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.',
2200     'type'        => 'textarea',
2201   },
2202
2203   {
2204     'key'         => 'credit_card-recurring_billing_flag',
2205     'section'     => 'billing',
2206     '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. ',
2207     'type'        => 'select',
2208     'select_hash' => [
2209                        'actual_oncard' => 'Default/classic behavior: set the flag if a customer has actual previous charges on the card.',
2210                        'transaction_is_recur' => 'Set the flag if the transaction itself is recurring, irregardless of previous charges on the card.',
2211                      ],
2212   },
2213
2214   {
2215     'key'         => 'credit_card-recurring_billing_acct_code',
2216     'section'     => 'billing',
2217     'description' => 'When the "recurring billing" flag is set, also set the "acct_code" to "rebill".  Useful for reporting purposes with supported gateways (PlugNPay, others?)',
2218     'type'        => 'checkbox',
2219   },
2220
2221   {
2222     'key'         => 'cvv-save',
2223     'section'     => 'billing',
2224     '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.',
2225     'type'        => 'selectmultiple',
2226     'select_enum' => \@card_types,
2227   },
2228
2229   {
2230     'key'         => 'manual_process-pkgpart',
2231     'section'     => 'billing',
2232     'description' => 'Package to add to each manual credit card and ACH payments entered from the backend.  Enabling this option may be in violation of your merchant agreement(s), so please check them carefully before enabling this option.',
2233     'type'        => 'select-part_pkg',
2234   },
2235
2236   {
2237     'key'         => 'manual_process-display',
2238     'section'     => 'billing',
2239     'description' => 'When using manual_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
2240     'type'        => 'select',
2241     'select_hash' => [
2242                        'add'      => 'Add fee to amount entered',
2243                        'subtract' => 'Subtract fee from amount entered',
2244                      ],
2245   },
2246
2247   {
2248     'key'         => 'manual_process-skip_first',
2249     'section'     => 'billing',
2250     'description' => "When using manual_process-pkgpart, omit the fee if it is the customer's first payment.",
2251     'type'        => 'checkbox',
2252   },
2253
2254   {
2255     'key'         => 'allow_negative_charges',
2256     'section'     => 'billing',
2257     'description' => 'Allow negative charges.  Normally not used unless importing data from a legacy system that requires this.',
2258     'type'        => 'checkbox',
2259   },
2260   {
2261       'key'         => 'auto_unset_catchall',
2262       'section'     => '',
2263       '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.',
2264       'type'        => 'checkbox',
2265   },
2266
2267   {
2268     'key'         => 'system_usernames',
2269     'section'     => 'username',
2270     'description' => 'A list of system usernames that cannot be edited or removed, one per line.  Use a bare username to prohibit modification/deletion of the username in any domain, or username@domain to prohibit modification/deletetion of a specific username and domain.',
2271     'type'        => 'textarea',
2272   },
2273
2274   {
2275     'key'         => 'cust_pkg-change_svcpart',
2276     'section'     => '',
2277     'description' => "When changing packages, move services even if svcparts don't match between old and new pacakge definitions.",
2278     'type'        => 'checkbox',
2279   },
2280
2281   {
2282     'key'         => 'cust_pkg-change_pkgpart-bill_now',
2283     'section'     => '',
2284     '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.",
2285     'type'        => 'checkbox',
2286   },
2287
2288   {
2289     'key'         => 'disable_autoreverse',
2290     'section'     => 'BIND',
2291     'description' => 'Disable automatic synchronization of reverse-ARPA entries.',
2292     'type'        => 'checkbox',
2293   },
2294
2295   {
2296     'key'         => 'svc_www-enable_subdomains',
2297     'section'     => '',
2298     'description' => 'Enable selection of specific subdomains for virtual host creation.',
2299     'type'        => 'checkbox',
2300   },
2301
2302   {
2303     'key'         => 'svc_www-usersvc_svcpart',
2304     'section'     => '',
2305     'description' => 'Allowable service definition svcparts for virtual hosts, one per line.',
2306     'type'        => 'select-part_svc',
2307     'multiple'    => 1,
2308   },
2309
2310   {
2311     'key'         => 'selfservice_server-primary_only',
2312     'section'     => 'self-service',
2313     'description' => 'Only allow primary accounts to access self-service functionality.',
2314     'type'        => 'checkbox',
2315   },
2316
2317   {
2318     'key'         => 'selfservice_server-phone_login',
2319     'section'     => 'self-service',
2320     'description' => 'Allow login to self-service with phone number and PIN.',
2321     'type'        => 'checkbox',
2322   },
2323
2324   {
2325     'key'         => 'selfservice_server-single_domain',
2326     'section'     => 'self-service',
2327     'description' => 'If specified, only use this one domain for self-service access.',
2328     'type'        => 'text',
2329   },
2330
2331   {
2332     'key'         => 'selfservice_server-login_svcpart',
2333     'section'     => 'self-service',
2334     'description' => 'If specified, only allow the specified svcparts to login to self-service.',
2335     'type'        => 'select-part_svc',
2336     'multiple'    => 1,
2337   },
2338
2339   {
2340     'key'         => 'selfservice-recent-did-age',
2341     'section'     => 'self-service',
2342     'description' => 'If specified, defines "recent", in number of seconds, for "Download recently allocated DIDs" in self-service.',
2343     'type'        => 'text',
2344   },
2345
2346   {
2347     'key'         => 'selfservice_server-view-wholesale',
2348     'section'     => 'self-service',
2349     'description' => 'If enabled, use a wholesale package view in the self-service.',
2350     'type'        => 'checkbox',
2351   },
2352
2353   {
2354     'key'         => 'selfservice-agent_signup',
2355     'section'     => 'self-service',
2356     'description' => 'Allow agent signup via self-service.',
2357     'type'        => 'checkbox',
2358   },
2359
2360   {
2361     'key'         => 'selfservice-agent_signup-agent_type',
2362     'section'     => 'self-service',
2363     'description' => 'Agent type when allowing agent signup via self-service.',
2364     'type'        => 'select-sub',
2365     'options_sub' => sub { require FS::Record;
2366                            require FS::agent_type;
2367                            map { $_->typenum => $_->atype }
2368                                FS::Record::qsearch('agent_type', {} ); # disabled=>'' } );
2369                          },
2370     'option_sub'  => sub { require FS::Record;
2371                            require FS::agent_type;
2372                            my $agent = FS::Record::qsearchs(
2373                              'agent_type', { 'typenum'=>shift }
2374                            );
2375                            $agent_type ? $agent_type->atype : '';
2376                          },
2377   },
2378
2379   {
2380     'key'         => 'selfservice-agent_login',
2381     'section'     => 'self-service',
2382     'description' => 'Allow agent login via self-service.',
2383     'type'        => 'checkbox',
2384   },
2385
2386   {
2387     'key'         => 'selfservice-self_suspend_reason',
2388     'section'     => 'self-service',
2389     'description' => 'Suspend reason when customers suspend their own packages. Set to nothing to disallow self-suspension.',
2390     'type'        => 'select-sub',
2391     'options_sub' => sub { require FS::Record;
2392                            require FS::reason;
2393                            my $type = qsearchs('reason_type',
2394                              { class => 'S' })
2395                               or return ();
2396                            map { $_->reasonnum => $_->reason }
2397                                FS::Record::qsearch('reason',
2398                                  { reason_type => $type->typenum }
2399                                );
2400                          },
2401     'option_sub'  => sub { require FS::Record;
2402                            require FS::reason;
2403                            my $reason = FS::Record::qsearchs(
2404                              'reason', { 'reasonnum' => shift }
2405                            );
2406                            $reason ? $reason->reason : '';
2407                          },
2408
2409     'per_agent'   => 1,
2410   },
2411
2412   {
2413     'key'         => 'card_refund-days',
2414     'section'     => 'billing',
2415     'description' => 'After a payment, the number of days a refund link will be available for that payment.  Defaults to 120.',
2416     'type'        => 'text',
2417   },
2418
2419   {
2420     'key'         => 'agent-showpasswords',
2421     'section'     => '',
2422     'description' => 'Display unencrypted user passwords in the agent (reseller) interface',
2423     'type'        => 'checkbox',
2424   },
2425
2426   {
2427     'key'         => 'global_unique-username',
2428     'section'     => 'username',
2429     'description' => 'Global username uniqueness control: none (usual setting - check uniqueness per exports), username (all usernames are globally unique, regardless of domain or exports), or username@domain (all username@domain 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.',
2430     'type'        => 'select',
2431     'select_enum' => [ 'none', 'username', 'username@domain', 'disabled' ],
2432   },
2433
2434   {
2435     'key'         => 'global_unique-phonenum',
2436     'section'     => '',
2437     '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.',
2438     'type'        => 'select',
2439     'select_enum' => [ 'none', 'countrycode+phonenum', 'disabled' ],
2440   },
2441
2442   {
2443     'key'         => 'global_unique-pbx_title',
2444     'section'     => '',
2445     'description' => 'Global phone number uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
2446     'type'        => 'select',
2447     'select_enum' => [ 'enabled', 'disabled' ],
2448   },
2449
2450   {
2451     'key'         => 'global_unique-pbx_id',
2452     'section'     => '',
2453     'description' => 'Global PBX id uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
2454     'type'        => 'select',
2455     'select_enum' => [ 'enabled', 'disabled' ],
2456   },
2457
2458   {
2459     'key'         => 'svc_external-skip_manual',
2460     'section'     => 'UI',
2461     'description' => 'When provisioning svc_external services, skip manual entry of id and title fields in the UI.  Usually used in conjunction with an export that populates these fields (i.e. artera_turbo).',
2462     'type'        => 'checkbox',
2463   },
2464
2465   {
2466     'key'         => 'svc_external-display_type',
2467     'section'     => 'UI',
2468     'description' => 'Select a specific svc_external type to enable some UI changes specific to that type (i.e. artera_turbo).',
2469     'type'        => 'select',
2470     'select_enum' => [ 'generic', 'artera_turbo', ],
2471   },
2472
2473   {
2474     'key'         => 'ticket_system',
2475     'section'     => '',
2476     '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).',
2477     'type'        => 'select',
2478     #'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
2479     'select_enum' => [ '', qw(RT_Internal RT_External) ],
2480   },
2481
2482   {
2483     'key'         => 'network_monitoring_system',
2484     'section'     => '',
2485     '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:2.1:Documentation:Torrus_Installation">integrated networking monitoring system installation instructions</a>).',
2486     'type'        => 'select',
2487     #'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
2488     'select_enum' => [ '', qw(Torrus_Internal) ],
2489   },
2490
2491   {
2492     'key'         => 'ticket_system-default_queueid',
2493     'section'     => '',
2494     'description' => 'Default queue used when creating new customer tickets.',
2495     'type'        => 'select-sub',
2496     'options_sub' => sub {
2497                            my $conf = new FS::Conf;
2498                            if ( $conf->config('ticket_system') ) {
2499                              eval "use FS::TicketSystem;";
2500                              die $@ if $@;
2501                              FS::TicketSystem->queues();
2502                            } else {
2503                              ();
2504                            }
2505                          },
2506     'option_sub'  => sub {
2507                            my $conf = new FS::Conf;
2508                            if ( $conf->config('ticket_system') ) {
2509                              eval "use FS::TicketSystem;";
2510                              die $@ if $@;
2511                              FS::TicketSystem->queue(shift);
2512                            } else {
2513                              '';
2514                            }
2515                          },
2516   },
2517   {
2518     'key'         => 'ticket_system-force_default_queueid',
2519     'section'     => '',
2520     'description' => 'Disallow queue selection when creating new tickets from customer view.',
2521     'type'        => 'checkbox',
2522   },
2523   {
2524     'key'         => 'ticket_system-selfservice_queueid',
2525     'section'     => '',
2526     'description' => 'Queue used when creating new customer tickets from self-service.  Defautls to ticket_system-default_queueid if not specified.',
2527     #false laziness w/above
2528     'type'        => 'select-sub',
2529     'options_sub' => sub {
2530                            my $conf = new FS::Conf;
2531                            if ( $conf->config('ticket_system') ) {
2532                              eval "use FS::TicketSystem;";
2533                              die $@ if $@;
2534                              FS::TicketSystem->queues();
2535                            } else {
2536                              ();
2537                            }
2538                          },
2539     'option_sub'  => sub {
2540                            my $conf = new FS::Conf;
2541                            if ( $conf->config('ticket_system') ) {
2542                              eval "use FS::TicketSystem;";
2543                              die $@ if $@;
2544                              FS::TicketSystem->queue(shift);
2545                            } else {
2546                              '';
2547                            }
2548                          },
2549   },
2550
2551   {
2552     'key'         => 'ticket_system-priority_reverse',
2553     'section'     => '',
2554     'description' => 'Enable this to consider lower numbered priorities more important.  A bad habit we picked up somewhere.  You probably want to avoid it and use the default.',
2555     'type'        => 'checkbox',
2556   },
2557
2558   {
2559     'key'         => 'ticket_system-custom_priority_field',
2560     'section'     => '',
2561     'description' => 'Custom field from the ticketing system to use as a custom priority classification.',
2562     'type'        => 'text',
2563   },
2564
2565   {
2566     'key'         => 'ticket_system-custom_priority_field-values',
2567     'section'     => '',
2568     'description' => 'Values for the custom field from the ticketing system to break down and sort customer ticket lists.',
2569     'type'        => 'textarea',
2570   },
2571
2572   {
2573     'key'         => 'ticket_system-custom_priority_field_queue',
2574     'section'     => '',
2575     'description' => 'Ticketing system queue in which the custom field specified in ticket_system-custom_priority_field is located.',
2576     'type'        => 'text',
2577   },
2578
2579   {
2580     'key'         => 'ticket_system-escalation',
2581     'section'     => '',
2582     'description' => 'Enable priority escalation of tickets as part of daily batch processing.',
2583     'type'        => 'checkbox',
2584   },
2585
2586   {
2587     'key'         => 'ticket_system-rt_external_datasrc',
2588     'section'     => '',
2589     '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>',
2590     'type'        => 'text',
2591
2592   },
2593
2594   {
2595     'key'         => 'ticket_system-rt_external_url',
2596     'section'     => '',
2597     'description' => 'With external RT integration, the URL for the external RT installation, for example, <code>https://rt.example.com/rt</code>',
2598     'type'        => 'text',
2599   },
2600
2601   {
2602     'key'         => 'company_name',
2603     'section'     => 'required',
2604     'description' => 'Your company name',
2605     'type'        => 'text',
2606     'per_agent'   => 1, #XXX just FS/FS/ClientAPI/Signup.pm
2607   },
2608
2609   {
2610     'key'         => 'company_address',
2611     'section'     => 'required',
2612     'description' => 'Your company address',
2613     'type'        => 'textarea',
2614     'per_agent'   => 1,
2615   },
2616
2617   {
2618     'key'         => 'echeck-void',
2619     'section'     => 'deprecated',
2620     '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',
2621     'type'        => 'checkbox',
2622   },
2623
2624   {
2625     'key'         => 'cc-void',
2626     'section'     => 'deprecated',
2627     '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',
2628     'type'        => 'checkbox',
2629   },
2630
2631   {
2632     'key'         => 'unvoid',
2633     'section'     => 'deprecated',
2634     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable unvoiding of voided payments',
2635     'type'        => 'checkbox',
2636   },
2637
2638   {
2639     'key'         => 'address1-search',
2640     'section'     => 'UI',
2641     '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.',
2642     'type'        => 'checkbox',
2643   },
2644
2645   {
2646     'key'         => 'address2-search',
2647     'section'     => 'UI',
2648     'description' => 'Enable a "Unit" search box which searches the second address field.  Useful for multi-tenant applications.  See also: cust_main-require_address2',
2649     'type'        => 'checkbox',
2650   },
2651
2652   {
2653     'key'         => 'cust_main-require_address2',
2654     'section'     => 'UI',
2655     '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',
2656     'type'        => 'checkbox',
2657   },
2658
2659   {
2660     'key'         => 'agent-ship_address',
2661     'section'     => '',
2662     '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.",
2663     'type'        => 'checkbox',
2664   },
2665
2666   { 'key'         => 'referral_credit',
2667     'section'     => 'deprecated',
2668     '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.",
2669     'type'        => 'checkbox',
2670   },
2671
2672   { 'key'         => 'selfservice_server-cache_module',
2673     'section'     => 'self-service',
2674     '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.',
2675     'type'        => 'select',
2676     'select_enum' => [ 'Cache::SharedMemoryCache', 'Cache::FileCache', ], # '_Database' ],
2677   },
2678
2679   {
2680     'key'         => 'hylafax',
2681     'section'     => 'billing',
2682     '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).',
2683     'type'        => [qw( checkbox textarea )],
2684   },
2685
2686   {
2687     'key'         => 'cust_bill-ftpformat',
2688     'section'     => 'invoicing',
2689     'description' => 'Enable FTP of raw invoice data - format.',
2690     'type'        => 'select',
2691     'select_enum' => [ '', 'default', 'billco', ],
2692   },
2693
2694   {
2695     'key'         => 'cust_bill-ftpserver',
2696     'section'     => 'invoicing',
2697     'description' => 'Enable FTP of raw invoice data - server.',
2698     'type'        => 'text',
2699   },
2700
2701   {
2702     'key'         => 'cust_bill-ftpusername',
2703     'section'     => 'invoicing',
2704     'description' => 'Enable FTP of raw invoice data - server.',
2705     'type'        => 'text',
2706   },
2707
2708   {
2709     'key'         => 'cust_bill-ftppassword',
2710     'section'     => 'invoicing',
2711     'description' => 'Enable FTP of raw invoice data - server.',
2712     'type'        => 'text',
2713   },
2714
2715   {
2716     'key'         => 'cust_bill-ftpdir',
2717     'section'     => 'invoicing',
2718     'description' => 'Enable FTP of raw invoice data - server.',
2719     'type'        => 'text',
2720   },
2721
2722   {
2723     'key'         => 'cust_bill-spoolformat',
2724     'section'     => 'invoicing',
2725     'description' => 'Enable spooling of raw invoice data - format.',
2726     'type'        => 'select',
2727     'select_enum' => [ '', 'default', 'billco', ],
2728   },
2729
2730   {
2731     'key'         => 'cust_bill-spoolagent',
2732     'section'     => 'invoicing',
2733     'description' => 'Enable per-agent spooling of raw invoice data.',
2734     'type'        => 'checkbox',
2735   },
2736
2737   {
2738     'key'         => 'svc_acct-usage_suspend',
2739     'section'     => 'billing',
2740     '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.',
2741     'type'        => 'checkbox',
2742   },
2743
2744   {
2745     'key'         => 'svc_acct-usage_unsuspend',
2746     'section'     => 'billing',
2747     '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.',
2748     'type'        => 'checkbox',
2749   },
2750
2751   {
2752     'key'         => 'svc_acct-usage_threshold',
2753     'section'     => 'billing',
2754     '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.',
2755     'type'        => 'text',
2756   },
2757
2758   {
2759     'key'         => 'overlimit_groups',
2760     'section'     => '',
2761     'description' => 'RADIUS group (or comma-separated groups) to assign to svc_acct which has exceeded its bandwidth or time limit.',
2762     'type'        => 'text',
2763     'per_agent'   => 1,
2764   },
2765
2766   {
2767     'key'         => 'cust-fields',
2768     'section'     => 'UI',
2769     'description' => 'Which customer fields to display on reports by default',
2770     'type'        => 'select',
2771     'select_hash' => [ FS::ConfDefaults->cust_fields_avail() ],
2772   },
2773
2774   {
2775     'key'         => 'cust_pkg-display_times',
2776     'section'     => 'UI',
2777     'description' => 'Display full timestamps (not just dates) for customer packages.  Useful if you are doing real-time things like hourly prepaid.',
2778     'type'        => 'checkbox',
2779   },
2780
2781   {
2782     'key'         => 'cust_pkg-always_show_location',
2783     'section'     => 'UI',
2784     'description' => "Always display package locations, even when they're all the default service address.",
2785     'type'        => 'checkbox',
2786   },
2787
2788   {
2789     'key'         => 'cust_pkg-group_by_location',
2790     'section'     => 'UI',
2791     'description' => "Group packages by location.",
2792     'type'        => 'checkbox',
2793   },
2794
2795   {
2796     'key'         => 'cust_pkg-show_fcc_voice_grade_equivalent',
2797     'section'     => 'UI',
2798     'description' => "Show a field on package definitions for assigning a DSO equivalency number suitable for use on FCC form 477.",
2799     'type'        => 'checkbox',
2800   },
2801
2802   {
2803     'key'         => 'cust_pkg-large_pkg_size',
2804     'section'     => 'UI',
2805     'description' => "In customer view, summarize packages with more than this many services.  Set to zero to never summarize packages.",
2806     'type'        => 'text',
2807   },
2808
2809   {
2810     'key'         => 'svc_acct-edit_uid',
2811     'section'     => 'shell',
2812     'description' => 'Allow UID editing.',
2813     'type'        => 'checkbox',
2814   },
2815
2816   {
2817     'key'         => 'svc_acct-edit_gid',
2818     'section'     => 'shell',
2819     'description' => 'Allow GID editing.',
2820     'type'        => 'checkbox',
2821   },
2822
2823   {
2824     'key'         => 'zone-underscore',
2825     'section'     => 'BIND',
2826     'description' => 'Allow underscores in zone names.  As underscores are illegal characters in zone names, this option is not recommended.',
2827     'type'        => 'checkbox',
2828   },
2829
2830   {
2831     'key'         => 'echeck-nonus',
2832     'section'     => 'billing',
2833     'description' => 'Disable ABA-format account checking for Electronic Check payment info',
2834     'type'        => 'checkbox',
2835   },
2836
2837   {
2838     'key'         => 'voip-cust_cdr_spools',
2839     'section'     => 'telephony',
2840     'description' => 'Enable the per-customer option for individual CDR spools.',
2841     'type'        => 'checkbox',
2842   },
2843
2844   {
2845     'key'         => 'voip-cust_cdr_squelch',
2846     'section'     => 'telephony',
2847     'description' => 'Enable the per-customer option for not printing CDR on invoices.',
2848     'type'        => 'checkbox',
2849   },
2850
2851   {
2852     'key'         => 'voip-cdr_email',
2853     'section'     => 'telephony',
2854     '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.',
2855     'type'        => 'checkbox',
2856   },
2857
2858   {
2859     'key'         => 'voip-cust_email_csv_cdr',
2860     'section'     => 'telephony',
2861     'description' => 'Enable the per-customer option for including CDR information as a CSV attachment on emailed invoices.',
2862     'type'        => 'checkbox',
2863   },
2864
2865   {
2866     'key'         => 'cgp_rule-domain_templates',
2867     'section'     => '',
2868     'description' => 'Communigate Pro rule templates for domains, one per line, "svcnum Name"',
2869     'type'        => 'textarea',
2870   },
2871
2872   {
2873     'key'         => 'svc_forward-no_srcsvc',
2874     'section'     => '',
2875     '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.",
2876     'type'        => 'checkbox',
2877   },
2878
2879   {
2880     'key'         => 'svc_forward-arbitrary_dst',
2881     'section'     => '',
2882     '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.",
2883     'type'        => 'checkbox',
2884   },
2885
2886   {
2887     'key'         => 'tax-ship_address',
2888     'section'     => 'billing',
2889     'description' => 'By default, tax calculations are done based on the billing address.  Enable this switch to calculate tax based on the shipping address instead.',
2890     'type'        => 'checkbox',
2891   }
2892 ,
2893   {
2894     'key'         => 'tax-pkg_address',
2895     'section'     => 'billing',
2896     '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).',
2897     'type'        => 'checkbox',
2898   },
2899
2900   {
2901     'key'         => 'invoice-ship_address',
2902     'section'     => 'invoicing',
2903     'description' => 'Include the shipping address on invoices.',
2904     'type'        => 'checkbox',
2905   },
2906
2907   {
2908     'key'         => 'invoice-unitprice',
2909     'section'     => 'invoicing',
2910     'description' => 'Enable unit pricing on invoices.',
2911     'type'        => 'checkbox',
2912   },
2913
2914   {
2915     'key'         => 'invoice-smallernotes',
2916     'section'     => 'invoicing',
2917     'description' => 'Display the notes section in a smaller font on invoices.',
2918     'type'        => 'checkbox',
2919   },
2920
2921   {
2922     'key'         => 'invoice-smallerfooter',
2923     'section'     => 'invoicing',
2924     'description' => 'Display footers in a smaller font on invoices.',
2925     'type'        => 'checkbox',
2926   },
2927
2928   {
2929     'key'         => 'postal_invoice-fee_pkgpart',
2930     'section'     => 'billing',
2931     'description' => 'This allows selection of a package to insert on invoices for customers with postal invoices selected.',
2932     'type'        => 'select-part_pkg',
2933   },
2934
2935   {
2936     'key'         => 'postal_invoice-recurring_only',
2937     'section'     => 'billing',
2938     'description' => 'The postal invoice fee is omitted on invoices without reucrring charges when this is set.',
2939     'type'        => 'checkbox',
2940   },
2941
2942   {
2943     'key'         => 'batch-enable',
2944     'section'     => 'deprecated', #make sure batch-enable_payby is set for
2945                                    #everyone before removing
2946     'description' => 'Enable credit card and/or ACH batching - leave disabled for real-time installations.',
2947     'type'        => 'checkbox',
2948   },
2949
2950   {
2951     'key'         => 'batch-enable_payby',
2952     'section'     => 'billing',
2953     'description' => 'Enable batch processing for the specified payment types.',
2954     'type'        => 'selectmultiple',
2955     'select_enum' => [qw( CARD CHEK )],
2956   },
2957
2958   {
2959     'key'         => 'realtime-disable_payby',
2960     'section'     => 'billing',
2961     'description' => 'Disable realtime processing for the specified payment types.',
2962     'type'        => 'selectmultiple',
2963     'select_enum' => [qw( CARD CHEK )],
2964   },
2965
2966   {
2967     'key'         => 'batch-default_format',
2968     'section'     => 'billing',
2969     'description' => 'Default format for batches.',
2970     'type'        => 'select',
2971     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch',
2972                        'csv-chase_canada-E-xactBatch', 'BoM', 'PAP',
2973                        'paymentech', 'ach-spiritone', 'RBC'
2974                     ]
2975   },
2976
2977   #lists could be auto-generated from pay_batch info
2978   {
2979     'key'         => 'batch-fixed_format-CARD',
2980     'section'     => 'billing',
2981     'description' => 'Fixed (unchangeable) format for credit card batches.',
2982     'type'        => 'select',
2983     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP' ,
2984                        'csv-chase_canada-E-xactBatch', 'paymentech' ]
2985   },
2986
2987   {
2988     'key'         => 'batch-fixed_format-CHEK',
2989     'section'     => 'billing',
2990     'description' => 'Fixed (unchangeable) format for electronic check batches.',
2991     'type'        => 'select',
2992     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP',
2993                        'paymentech', 'ach-spiritone', 'RBC', 'td_eft1464'
2994                      ]
2995   },
2996
2997   {
2998     'key'         => 'batch-increment_expiration',
2999     'section'     => 'billing',
3000     'description' => 'Increment expiration date years in batches until cards are current.  Make sure this is acceptable to your batching provider before enabling.',
3001     'type'        => 'checkbox'
3002   },
3003
3004   {
3005     'key'         => 'batchconfig-BoM',
3006     'section'     => 'billing',
3007     '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',
3008     'type'        => 'textarea',
3009   },
3010
3011   {
3012     'key'         => 'batchconfig-PAP',
3013     'section'     => 'billing',
3014     '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',
3015     'type'        => 'textarea',
3016   },
3017
3018   {
3019     'key'         => 'batchconfig-csv-chase_canada-E-xactBatch',
3020     'section'     => 'billing',
3021     'description' => 'Gateway ID for Chase Canada E-xact batching',
3022     'type'        => 'text',
3023   },
3024
3025   {
3026     'key'         => 'batchconfig-paymentech',
3027     'section'     => 'billing',
3028     'description' => 'Configuration for Chase Paymentech batching, five lines: 1. BIN, 2. Terminal ID, 3. Merchant ID, 4. Username, 5. Password (for batch uploads)',
3029     'type'        => 'textarea',
3030   },
3031
3032   {
3033     'key'         => 'batchconfig-RBC',
3034     'section'     => 'billing',
3035     'description' => 'Configuration for Royal Bank of Canada PDS batching, four lines: 1. Client number, 2. Short name, 3. Long name, 4. Transaction code.',
3036     'type'        => 'textarea',
3037   },
3038
3039   {
3040     'key'         => 'batchconfig-td_eft1464',
3041     'section'     => 'billing',
3042     '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.',
3043     'type'        => 'textarea',
3044   },
3045
3046   {
3047     'key'         => 'batch-manual_approval',
3048     'section'     => 'billing',
3049     'description' => 'Allow manual batch closure, which will approve all payments that do not yet have a status.  This is not advised, but is needed for payment processors that provide a report of rejected rather than approved payments.',
3050     'type'        => 'checkbox',
3051   },
3052
3053   {
3054     'key'         => 'payment_history-years',
3055     'section'     => 'UI',
3056     'description' => 'Number of years of payment history to show by default.  Currently defaults to 2.',
3057     'type'        => 'text',
3058   },
3059
3060   {
3061     'key'         => 'change_history-years',
3062     'section'     => 'UI',
3063     'description' => 'Number of years of change history to show by default.  Currently defaults to 0.5.',
3064     'type'        => 'text',
3065   },
3066
3067   {
3068     'key'         => 'cust_main-packages-years',
3069     'section'     => 'UI',
3070     'description' => 'Number of years to show old (cancelled and one-time charge) packages by default.  Currently defaults to 2.',
3071     'type'        => 'text',
3072   },
3073
3074   {
3075     'key'         => 'cust_main-use_comments',
3076     'section'     => 'UI',
3077     'description' => 'Display free form comments on the customer edit screen.  Useful as a scratch pad.',
3078     'type'        => 'checkbox',
3079   },
3080
3081   {
3082     'key'         => 'cust_main-disable_notes',
3083     'section'     => 'UI',
3084     'description' => 'Disable new style customer notes - timestamped and user identified customer notes.  Useful in tracking who did what.',
3085     'type'        => 'checkbox',
3086   },
3087
3088   {
3089     'key'         => 'cust_main_note-display_times',
3090     'section'     => 'UI',
3091     'description' => 'Display full timestamps (not just dates) for customer notes.',
3092     'type'        => 'checkbox',
3093   },
3094
3095   {
3096     'key'         => 'cust_main-ticket_statuses',
3097     'section'     => 'UI',
3098     'description' => 'Show tickets with these statuses on the customer view page.',
3099     'type'        => 'selectmultiple',
3100     'select_enum' => [qw( new open stalled resolved rejected deleted )],
3101   },
3102
3103   {
3104     'key'         => 'cust_main-max_tickets',
3105     'section'     => 'UI',
3106     'description' => 'Maximum number of tickets to show on the customer view page.',
3107     'type'        => 'text',
3108   },
3109
3110   {
3111     'key'         => 'cust_main-skeleton_tables',
3112     'section'     => '',
3113     'description' => 'Tables which will have skeleton records inserted into them for each customer.  Syntax for specifying tables is unfortunately a tricky perl data structure for now.',
3114     'type'        => 'textarea',
3115   },
3116
3117   {
3118     'key'         => 'cust_main-skeleton_custnum',
3119     'section'     => '',
3120     'description' => 'Customer number specifying the source data to copy into skeleton tables for new customers.',
3121     'type'        => 'text',
3122   },
3123
3124   {
3125     'key'         => 'cust_main-enable_birthdate',
3126     'section'     => 'UI',
3127     'descritpion' => 'Enable tracking of a birth date with each customer record',
3128     'type'        => 'checkbox',
3129   },
3130
3131   {
3132     'key'         => 'support-key',
3133     'section'     => '',
3134     '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.',
3135     'type'        => 'text',
3136   },
3137
3138   {
3139     'key'         => 'card-types',
3140     'section'     => 'billing',
3141     'description' => 'Select one or more card types to enable only those card types.  If no card types are selected, all card types are available.',
3142     'type'        => 'selectmultiple',
3143     'select_enum' => \@card_types,
3144   },
3145
3146   {
3147     'key'         => 'disable-fuzzy',
3148     'section'     => 'UI',
3149     'description' => 'Disable fuzzy searching.  Speeds up searching for large sites, but only shows exact matches.',
3150     'type'        => 'checkbox',
3151   },
3152
3153   { 'key'         => 'pkg_referral',
3154     'section'     => '',
3155     'description' => 'Enable package-specific advertising sources.',
3156     'type'        => 'checkbox',
3157   },
3158
3159   { 'key'         => 'pkg_referral-multiple',
3160     'section'     => '',
3161     'description' => 'In addition, allow multiple advertising sources to be associated with a single package.',
3162     'type'        => 'checkbox',
3163   },
3164
3165   {
3166     'key'         => 'dashboard-install_welcome',
3167     'section'     => 'UI',
3168     'description' => 'New install welcome screen.',
3169     'type'        => 'select',
3170     'select_enum' => [ '', 'ITSP_fsinc_hosted', ],
3171   },
3172
3173   {
3174     'key'         => 'dashboard-toplist',
3175     'section'     => 'UI',
3176     'description' => 'List of items to display on the top of the front page',
3177     'type'        => 'textarea',
3178   },
3179
3180   {
3181     'key'         => 'impending_recur_msgnum',
3182     'section'     => 'notification',
3183     'description' => 'Template to use for alerts about first-time recurring billing.',
3184     %msg_template_options,
3185   },
3186
3187   {
3188     'key'         => 'impending_recur_template',
3189     'section'     => 'deprecated',
3190     '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>',
3191 # <li><code>$payby</code> <li><code>$expdate</code> most likely only confuse
3192     'type'        => 'textarea',
3193   },
3194
3195   {
3196     'key'         => 'logo.png',
3197     'section'     => 'UI',  #'invoicing' ?
3198     'description' => 'Company logo for HTML invoices and the backoffice interface, in PNG format.  Suggested size somewhere near 92x62.',
3199     'type'        => 'image',
3200     'per_agent'   => 1, #XXX just view/logo.cgi, which is for the global
3201                         #old-style editor anyway...?
3202   },
3203
3204   {
3205     'key'         => 'logo.eps',
3206     'section'     => 'invoicing',
3207     'description' => 'Company logo for printed and PDF invoices, in EPS format.',
3208     'type'        => 'image',
3209     'per_agent'   => 1, #XXX as above, kinda
3210   },
3211
3212   {
3213     'key'         => 'selfservice-ignore_quantity',
3214     'section'     => 'self-service',
3215     'description' => 'Ignores service quantity restrictions in self-service context.  Strongly not recommended - just set your quantities correctly in the first place.',
3216     'type'        => 'checkbox',
3217   },
3218
3219   {
3220     'key'         => 'selfservice-session_timeout',
3221     'section'     => 'self-service',
3222     'description' => 'Self-service session timeout.  Defaults to 1 hour.',
3223     'type'        => 'select',
3224     'select_enum' => [ '1 hour', '2 hours', '4 hours', '8 hours', '1 day', '1 week', ],
3225   },
3226
3227   {
3228     'key'         => 'disable_setup_suspended_pkgs',
3229     'section'     => 'billing',
3230     'description' => 'Disables charging of setup fees for suspended packages.',
3231     'type'        => 'checkbox',
3232   },
3233
3234   {
3235     'key'         => 'password-generated-allcaps',
3236     'section'     => 'password',
3237     'description' => 'Causes passwords automatically generated to consist entirely of capital letters',
3238     'type'        => 'checkbox',
3239   },
3240
3241   {
3242     'key'         => 'datavolume-forcemegabytes',
3243     'section'     => 'UI',
3244     'description' => 'All data volumes are expressed in megabytes',
3245     'type'        => 'checkbox',
3246   },
3247
3248   {
3249     'key'         => 'datavolume-significantdigits',
3250     'section'     => 'UI',
3251     'description' => 'number of significant digits to use to represent data volumes',
3252     'type'        => 'text',
3253   },
3254
3255   {
3256     'key'         => 'disable_void_after',
3257     'section'     => 'billing',
3258     'description' => 'Number of seconds after which freeside won\'t attempt to VOID a payment first when performing a refund.',
3259     'type'        => 'text',
3260   },
3261
3262   {
3263     'key'         => 'disable_line_item_date_ranges',
3264     'section'     => 'billing',
3265     'description' => 'Prevent freeside from automatically generating date ranges on invoice line items.',
3266     'type'        => 'checkbox',
3267   },
3268
3269   {
3270     'key'         => 'support_packages',
3271     'section'     => '',
3272     '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...
3273     'type'        => 'select-part_pkg',
3274     'multiple'    => 1,
3275   },
3276
3277   {
3278     'key'         => 'cust_main-require_phone',
3279     'section'     => '',
3280     'description' => 'Require daytime or night phone for all customer records.',
3281     'type'        => 'checkbox',
3282   },
3283
3284   {
3285     'key'         => 'cust_main-require_invoicing_list_email',
3286     'section'     => '',
3287     'description' => 'Email address field is required: require at least one invoicing email address for all customer records.',
3288     'type'        => 'checkbox',
3289   },
3290
3291   {
3292     'key'         => 'svc_acct-display_paid_time_remaining',
3293     'section'     => '',
3294     'description' => 'Show paid time remaining in addition to time remaining.',
3295     'type'        => 'checkbox',
3296   },
3297
3298   {
3299     'key'         => 'cancel_credit_type',
3300     'section'     => 'billing',
3301     'description' => 'The group to use for new, automatically generated credit reasons resulting from cancellation.',
3302     'type'        => 'select-sub',
3303     'options_sub' => sub { require FS::Record;
3304                            require FS::reason_type;
3305                            map { $_->typenum => $_->type }
3306                                FS::Record::qsearch('reason_type', { class=>'R' } );
3307                          },
3308     'option_sub'  => sub { require FS::Record;
3309                            require FS::reason_type;
3310                            my $reason_type = FS::Record::qsearchs(
3311                              'reason_type', { 'typenum' => shift }
3312                            );
3313                            $reason_type ? $reason_type->type : '';
3314                          },
3315   },
3316
3317   {
3318     'key'         => 'referral_credit_type',
3319     'section'     => 'deprecated',
3320     '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.',
3321     'type'        => 'select-sub',
3322     'options_sub' => sub { require FS::Record;
3323                            require FS::reason_type;
3324                            map { $_->typenum => $_->type }
3325                                FS::Record::qsearch('reason_type', { class=>'R' } );
3326                          },
3327     'option_sub'  => sub { require FS::Record;
3328                            require FS::reason_type;
3329                            my $reason_type = FS::Record::qsearchs(
3330                              'reason_type', { 'typenum' => shift }
3331                            );
3332                            $reason_type ? $reason_type->type : '';
3333                          },
3334   },
3335
3336   {
3337     'key'         => 'signup_credit_type',
3338     'section'     => 'billing', #self-service?
3339     'description' => 'The group to use for new, automatically generated credit reasons resulting from signup and self-service declines.',
3340     'type'        => 'select-sub',
3341     'options_sub' => sub { require FS::Record;
3342                            require FS::reason_type;
3343                            map { $_->typenum => $_->type }
3344                                FS::Record::qsearch('reason_type', { class=>'R' } );
3345                          },
3346     'option_sub'  => sub { require FS::Record;
3347                            require FS::reason_type;
3348                            my $reason_type = FS::Record::qsearchs(
3349                              'reason_type', { 'typenum' => shift }
3350                            );
3351                            $reason_type ? $reason_type->type : '';
3352                          },
3353   },
3354
3355   {
3356     'key'         => 'prepayment_discounts-credit_type',
3357     'section'     => 'billing',
3358     'description' => 'Enables the offering of prepayment discounts and establishes the credit reason type.',
3359     'type'        => 'select-sub',
3360     'options_sub' => sub { require FS::Record;
3361                            require FS::reason_type;
3362                            map { $_->typenum => $_->type }
3363                                FS::Record::qsearch('reason_type', { class=>'R' } );
3364                          },
3365     'option_sub'  => sub { require FS::Record;
3366                            require FS::reason_type;
3367                            my $reason_type = FS::Record::qsearchs(
3368                              'reason_type', { 'typenum' => shift }
3369                            );
3370                            $reason_type ? $reason_type->type : '';
3371                          },
3372
3373   },
3374
3375   {
3376     'key'         => 'cust_main-agent_custid-format',
3377     'section'     => '',
3378     'description' => 'Enables searching of various formatted values in cust_main.agent_custid',
3379     'type'        => 'select',
3380     'select_hash' => [
3381                        ''      => 'Numeric only',
3382                        '\d{7}' => 'Numeric only, exactly 7 digits',
3383                        'ww?d+' => 'Numeric with one or two letter prefix',
3384                      ],
3385   },
3386
3387   {
3388     'key'         => 'card_masking_method',
3389     'section'     => 'UI',
3390     '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.',
3391     'type'        => 'select',
3392     'select_hash' => [
3393                        ''            => '123456xxxxxx1234',
3394                        'first6last2' => '123456xxxxxxxx12',
3395                        'first4last4' => '1234xxxxxxxx1234',
3396                        'first4last2' => '1234xxxxxxxxxx12',
3397                        'first2last4' => '12xxxxxxxxxx1234',
3398                        'first2last2' => '12xxxxxxxxxxxx12',
3399                        'first0last4' => 'xxxxxxxxxxxx1234',
3400                        'first0last2' => 'xxxxxxxxxxxxxx12',
3401                      ],
3402   },
3403
3404   {
3405     'key'         => 'disable_previous_balance',
3406     'section'     => 'invoicing',
3407     'description' => 'Disable inclusion of previous balance, payment, and credit lines on invoices',
3408     'type'        => 'checkbox',
3409   },
3410
3411   {
3412     'key'         => 'previous_balance-exclude_from_total',
3413     'section'     => 'invoicing',
3414     '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',
3415     'type'        => [ qw(checkbox text) ],
3416   },
3417
3418   {
3419     'key'         => 'previous_balance-summary_only',
3420     'section'     => 'invoicing',
3421     'description' => 'Only show a single line summarizing the total previous balance rather than one line per invoice.',
3422     'type'        => 'checkbox',
3423   },
3424
3425   {
3426     'key'         => 'balance_due_below_line',
3427     'section'     => 'invoicing',
3428     'description' => 'Place the balance due message below a line.  Only meaningful when when invoice_sections is false.',
3429     'type'        => 'checkbox',
3430   },
3431
3432   {
3433     'key'         => 'usps_webtools-userid',
3434     'section'     => 'UI',
3435     '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.',
3436     'type'        => 'text',
3437   },
3438
3439   {
3440     'key'         => 'usps_webtools-password',
3441     'section'     => 'UI',
3442     '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.',
3443     'type'        => 'text',
3444   },
3445
3446   {
3447     'key'         => 'cust_main-auto_standardize_address',
3448     'section'     => 'UI',
3449     'description' => 'When using USPS web tools, automatically standardize the address without asking.',
3450     'type'        => 'checkbox',
3451   },
3452
3453   {
3454     'key'         => 'cust_main-require_censustract',
3455     'section'     => 'UI',
3456     'description' => 'Customer is required to have a census tract.  Useful for FCC form 477 reports. See also: cust_main-auto_standardize_address',
3457     'type'        => 'checkbox',
3458   },
3459
3460   {
3461     'key'         => 'census_year',
3462     'section'     => 'UI',
3463     'description' => 'The year to use in census tract lookups',
3464     'type'        => 'select',
3465     'select_enum' => [ qw( 2010 2009 2008 ) ],
3466   },
3467
3468   {
3469     'key'         => 'company_latitude',
3470     'section'     => 'UI',
3471     'description' => 'Your company latitude (-90 through 90)',
3472     'type'        => 'text',
3473   },
3474
3475   {
3476     'key'         => 'company_longitude',
3477     'section'     => 'UI',
3478     'description' => 'Your company longitude (-180 thru 180)',
3479     'type'        => 'text',
3480   },
3481
3482   {
3483     'key'         => 'disable_acl_changes',
3484     'section'     => '',
3485     'description' => 'Disable all ACL changes, for demos.',
3486     'type'        => 'checkbox',
3487   },
3488
3489   {
3490     'key'         => 'disable_settings_changes',
3491     'section'     => '',
3492     'description' => 'Disable all settings changes, for demos, except for the usernames given in the comma-separated list.',
3493     'type'        => [qw( checkbox text )],
3494   },
3495
3496   {
3497     'key'         => 'cust_main-edit_agent_custid',
3498     'section'     => 'UI',
3499     'description' => 'Enable editing of the agent_custid field.',
3500     'type'        => 'checkbox',
3501   },
3502
3503   {
3504     'key'         => 'cust_main-default_agent_custid',
3505     'section'     => 'UI',
3506     'description' => 'Display the agent_custid field when available instead of the custnum field.',
3507     'type'        => 'checkbox',
3508   },
3509
3510   {
3511     'key'         => 'cust_main-title-display_custnum',
3512     'section'     => 'UI',
3513     'description' => 'Add the display_custom (agent_custid or custnum) to the title on customer view pages.',
3514     'type'        => 'checkbox',
3515   },
3516
3517   {
3518     'key'         => 'cust_bill-default_agent_invid',
3519     'section'     => 'UI',
3520     'description' => 'Display the agent_invid field when available instead of the invnum field.',
3521     'type'        => 'checkbox',
3522   },
3523
3524   {
3525     'key'         => 'cust_main-auto_agent_custid',
3526     'section'     => 'UI',
3527     'description' => 'Automatically assign an agent_custid - select format',
3528     'type'        => 'select',
3529     'select_hash' => [ '' => 'No',
3530                        '1YMMXXXXXXXX' => '1YMMXXXXXXXX',
3531                      ],
3532   },
3533
3534   {
3535     'key'         => 'cust_main-default_areacode',
3536     'section'     => 'UI',
3537     'description' => 'Default area code for customers.',
3538     'type'        => 'text',
3539   },
3540
3541   {
3542     'key'         => 'order_pkg-no_start_date',
3543     'section'     => 'UI',
3544     'description' => 'Don\'t set a default start date for new packages.',
3545     'type'        => 'checkbox',
3546   },
3547
3548   {
3549     'key'         => 'mcp_svcpart',
3550     'section'     => '',
3551     'description' => 'Master Control Program svcpart.  Leave this blank.',
3552     'type'        => 'text', #select-part_svc
3553   },
3554
3555   {
3556     'key'         => 'cust_bill-max_same_services',
3557     'section'     => 'invoicing',
3558     'description' => 'Maximum number of the same service to list individually on invoices before condensing to a single line listing the number of services.  Defaults to 5.',
3559     'type'        => 'text',
3560   },
3561
3562   {
3563     'key'         => 'cust_bill-consolidate_services',
3564     'section'     => 'invoicing',
3565     'description' => 'Consolidate service display into fewer lines on invoices rather than one per service.',
3566     'type'        => 'checkbox',
3567   },
3568
3569   {
3570     'key'         => 'suspend_email_admin',
3571     'section'     => '',
3572     'description' => 'Destination admin email address to enable suspension notices',
3573     'type'        => 'text',
3574   },
3575
3576   {
3577     'key'         => 'email_report-subject',
3578     'section'     => '',
3579     'description' => 'Subject for reports emailed by freeside-fetch.  Defaults to "Freeside report".',
3580     'type'        => 'text',
3581   },
3582
3583   {
3584     'key'         => 'selfservice-head',
3585     'section'     => 'self-service',
3586     'description' => 'HTML for the HEAD section of the self-service interface, typically used for LINK stylesheet tags',
3587     'type'        => 'textarea', #htmlarea?
3588     'per_agent'   => 1,
3589   },
3590
3591
3592   {
3593     'key'         => 'selfservice-body_header',
3594     'section'     => 'self-service',
3595     'description' => 'HTML header for the self-service interface',
3596     'type'        => 'textarea', #htmlarea?
3597     'per_agent'   => 1,
3598   },
3599
3600   {
3601     'key'         => 'selfservice-body_footer',
3602     'section'     => 'self-service',
3603     'description' => 'HTML footer for the self-service interface',
3604     'type'        => 'textarea', #htmlarea?
3605     'per_agent'   => 1,
3606   },
3607
3608
3609   {
3610     'key'         => 'selfservice-body_bgcolor',
3611     'section'     => 'self-service',
3612     'description' => 'HTML background color for the self-service interface, for example, #FFFFFF',
3613     'type'        => 'text',
3614     'per_agent'   => 1,
3615   },
3616
3617   {
3618     'key'         => 'selfservice-box_bgcolor',
3619     'section'     => 'self-service',
3620     'description' => 'HTML color for self-service interface input boxes, for example, #C0C0C0',
3621     'type'        => 'text',
3622     'per_agent'   => 1,
3623   },
3624
3625   {
3626     'key'         => 'selfservice-text_color',
3627     'section'     => 'self-service',
3628     'description' => 'HTML text color for the self-service interface, for example, #000000',
3629     'type'        => 'text',
3630     'per_agent'   => 1,
3631   },
3632
3633   {
3634     'key'         => 'selfservice-link_color',
3635     'section'     => 'self-service',
3636     'description' => 'HTML link color for the self-service interface, for example, #0000FF',
3637     'type'        => 'text',
3638     'per_agent'   => 1,
3639   },
3640
3641   {
3642     'key'         => 'selfservice-vlink_color',
3643     'section'     => 'self-service',
3644     'description' => 'HTML visited link color for the self-service interface, for example, #FF00FF',
3645     'type'        => 'text',
3646     'per_agent'   => 1,
3647   },
3648
3649   {
3650     'key'         => 'selfservice-hlink_color',
3651     'section'     => 'self-service',
3652     'description' => 'HTML hover link color for the self-service interface, for example, #808080',
3653     'type'        => 'text',
3654     'per_agent'   => 1,
3655   },
3656
3657   {
3658     'key'         => 'selfservice-alink_color',
3659     'section'     => 'self-service',
3660     'description' => 'HTML active (clicked) link color for the self-service interface, for example, #808080',
3661     'type'        => 'text',
3662     'per_agent'   => 1,
3663   },
3664
3665   {
3666     'key'         => 'selfservice-font',
3667     'section'     => 'self-service',
3668     'description' => 'HTML font CSS for the self-service interface, for example, 0.9em/1.5em Arial, Helvetica, Geneva, sans-serif',
3669     'type'        => 'text',
3670     'per_agent'   => 1,
3671   },
3672
3673   {
3674     'key'         => 'selfservice-title_color',
3675     'section'     => 'self-service',
3676     'description' => 'HTML color for the self-service title, for example, #000000',
3677     'type'        => 'text',
3678     'per_agent'   => 1,
3679   },
3680
3681   {
3682     'key'         => 'selfservice-title_align',
3683     'section'     => 'self-service',
3684     'description' => 'HTML alignment for the self-service title, for example, center',
3685     'type'        => 'text',
3686     'per_agent'   => 1,
3687   },
3688   {
3689     'key'         => 'selfservice-title_size',
3690     'section'     => 'self-service',
3691     'description' => 'HTML font size for the self-service title, for example, 3',
3692     'type'        => 'text',
3693     'per_agent'   => 1,
3694   },
3695
3696   {
3697     'key'         => 'selfservice-title_left_image',
3698     'section'     => 'self-service',
3699     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3700     'type'        => 'image',
3701     'per_agent'   => 1,
3702   },
3703
3704   {
3705     'key'         => 'selfservice-title_right_image',
3706     'section'     => 'self-service',
3707     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3708     'type'        => 'image',
3709     'per_agent'   => 1,
3710   },
3711
3712   {
3713     'key'         => 'selfservice-menu_skipblanks',
3714     'section'     => 'self-service',
3715     'description' => 'Skip blank (spacer) entries in the self-service menu',
3716     'type'        => 'checkbox',
3717     'per_agent'   => 1,
3718   },
3719
3720   {
3721     'key'         => 'selfservice-menu_skipheadings',
3722     'section'     => 'self-service',
3723     'description' => 'Skip the unclickable heading entries in the self-service menu',
3724     'type'        => 'checkbox',
3725     'per_agent'   => 1,
3726   },
3727
3728   {
3729     'key'         => 'selfservice-menu_bgcolor',
3730     'section'     => 'self-service',
3731     'description' => 'HTML color for the self-service menu, for example, #C0C0C0',
3732     'type'        => 'text',
3733     'per_agent'   => 1,
3734   },
3735
3736   {
3737     'key'         => 'selfservice-menu_fontsize',
3738     'section'     => 'self-service',
3739     'description' => 'HTML font size for the self-service menu, for example, -1',
3740     'type'        => 'text',
3741     'per_agent'   => 1,
3742   },
3743   {
3744     'key'         => 'selfservice-menu_nounderline',
3745     'section'     => 'self-service',
3746     'description' => 'Styles menu links in the self-service without underlining.',
3747     'type'        => 'checkbox',
3748     'per_agent'   => 1,
3749   },
3750
3751
3752   {
3753     'key'         => 'selfservice-menu_top_image',
3754     'section'     => 'self-service',
3755     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3756     'type'        => 'image',
3757     'per_agent'   => 1,
3758   },
3759
3760   {
3761     'key'         => 'selfservice-menu_body_image',
3762     'section'     => 'self-service',
3763     'description' => 'Repeating image used for the body of the menu in the self-service interface, in PNG format.',
3764     'type'        => 'image',
3765     'per_agent'   => 1,
3766   },
3767
3768   {
3769     'key'         => 'selfservice-menu_bottom_image',
3770     'section'     => 'self-service',
3771     'description' => 'Image used for the bottom of the menu in the self-service interface, in PNG format.',
3772     'type'        => 'image',
3773     'per_agent'   => 1,
3774   },
3775
3776   {
3777     'key'         => 'selfservice-bulk_format',
3778     'section'     => 'deprecated',
3779     'description' => 'Parameter arrangement for selfservice bulk features',
3780     'type'        => 'select',
3781     'select_enum' => [ '', 'izoom-soap', 'izoom-ftp' ],
3782     'per_agent'   => 1,
3783   },
3784
3785   {
3786     'key'         => 'selfservice-bulk_ftp_dir',
3787     'section'     => 'deprecated',
3788     'description' => 'Enable bulk ftp provisioning in this folder',
3789     'type'        => 'text',
3790     'per_agent'   => 1,
3791   },
3792
3793   {
3794     'key'         => 'signup-no_company',
3795     'section'     => 'self-service',
3796     'description' => "Don't display a field for company name on signup.",
3797     'type'        => 'checkbox',
3798   },
3799
3800   {
3801     'key'         => 'signup-recommend_email',
3802     'section'     => 'self-service',
3803     'description' => 'Encourage the entry of an invoicing email address on signup.',
3804     'type'        => 'checkbox',
3805   },
3806
3807   {
3808     'key'         => 'signup-recommend_daytime',
3809     'section'     => 'self-service',
3810     'description' => 'Encourage the entry of a daytime phone number  invoicing email address on signup.',
3811     'type'        => 'checkbox',
3812   },
3813
3814   {
3815     'key'         => 'svc_phone-radius-default_password',
3816     'section'     => 'telephony',
3817     'description' => 'Default password when exporting svc_phone records to RADIUS',
3818     'type'        => 'text',
3819   },
3820
3821   {
3822     'key'         => 'svc_phone-allow_alpha_phonenum',
3823     'section'     => 'telephony',
3824     'description' => 'Allow letters in phone numbers.',
3825     'type'        => 'checkbox',
3826   },
3827
3828   {
3829     'key'         => 'svc_phone-domain',
3830     'section'     => 'telephony',
3831     'description' => 'Track an optional domain association with each phone service.',
3832     'type'        => 'checkbox',
3833   },
3834
3835   {
3836     'key'         => 'svc_phone-phone_name-max_length',
3837     'section'     => 'telephony',
3838     'description' => 'Maximum length of the phone service "Name" field (svc_phone.phone_name).  Sometimes useful to limit this (to 15?) when exporting as Caller ID data.',
3839     'type'        => 'text',
3840   },
3841
3842   {
3843     'key'         => 'svc_phone-lnp',
3844     'section'     => 'telephony',
3845     'description' => 'Enables Number Portability features for svc_phone',
3846     'type'        => 'checkbox',
3847   },
3848
3849   {
3850     'key'         => 'default_phone_countrycode',
3851     'section'     => '',
3852     'description' => 'Default countrcode',
3853     'type'        => 'text',
3854   },
3855
3856   {
3857     'key'         => 'cdr-charged_party-field',
3858     'section'     => 'telephony',
3859     'description' => 'Set the charged_party field of CDRs to this field.',
3860     'type'        => 'select-sub',
3861     'options_sub' => sub { my $fields = FS::cdr->table_info->{'fields'};
3862                            map { $_ => $fields->{$_}||$_ }
3863                            grep { $_ !~ /^(acctid|charged_party)$/ }
3864                            FS::Schema::dbdef->table('cdr')->columns;
3865                          },
3866     'option_sub'  => sub { my $f = shift;
3867                            FS::cdr->table_info->{'fields'}{$f} || $f;
3868                          },
3869   },
3870
3871   #probably deprecate in favor of cdr-charged_party-field above
3872   {
3873     'key'         => 'cdr-charged_party-accountcode',
3874     'section'     => 'telephony',
3875     'description' => 'Set the charged_party field of CDRs to the accountcode.',
3876     'type'        => 'checkbox',
3877   },
3878
3879   {
3880     'key'         => 'cdr-charged_party-accountcode-trim_leading_0s',
3881     'section'     => 'telephony',
3882     'description' => 'When setting the charged_party field of CDRs to the accountcode, trim any leading zeros.',
3883     'type'        => 'checkbox',
3884   },
3885
3886 #  {
3887 #    'key'         => 'cdr-charged_party-truncate_prefix',
3888 #    'section'     => '',
3889 #    'description' => 'If the charged_party field has this prefix, truncate it to the length in cdr-charged_party-truncate_length.',
3890 #    'type'        => 'text',
3891 #  },
3892 #
3893 #  {
3894 #    'key'         => 'cdr-charged_party-truncate_length',
3895 #    'section'     => '',
3896 #    'description' => 'If the charged_party field has the prefix in cdr-charged_party-truncate_prefix, truncate it to this length.',
3897 #    'type'        => 'text',
3898 #  },
3899
3900   {
3901     'key'         => 'cdr-charged_party_rewrite',
3902     'section'     => 'telephony',
3903     '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*.',
3904     'type'        => 'checkbox',
3905   },
3906
3907   {
3908     'key'         => 'cdr-taqua-da_rewrite',
3909     'section'     => '',
3910     'description' => 'For the Taqua CDR format, a comma-separated list of directory assistance 800 numbers.  Any CDRs with these numbers as "BilledNumber" will be rewritten to the "CallingPartyNumber" (and CallType "12") on import.',
3911     'type'        => 'text',
3912   },
3913
3914   {
3915     'key'         => 'cust_pkg-show_autosuspend',
3916     'section'     => 'UI',
3917     'description' => 'Show package auto-suspend dates.  Use with caution for now; can slow down customer view for large insallations.',
3918     'type'        => 'checkbox',
3919   },
3920
3921   {
3922     'key'         => 'cdr-asterisk_forward_rewrite',
3923     'section'     => 'telephony',
3924     'description' => 'Enable special processing for CDRs representing forwarded calls: For CDRs that have a dcontext that starts with "Local/" but does not match dst, set charged_party to dst, parse a new dst from dstchannel, and set amaflags to "2" ("BILL"/"BILLING").',
3925     'type'        => 'checkbox',
3926   },
3927
3928   {
3929     'key'         => 'sg-multicustomer_hack',
3930     'section'     => '',
3931     'description' => "Don't use this.",
3932     'type'        => 'checkbox',
3933   },
3934
3935   {
3936     'key'         => 'sg-ping_username',
3937     'section'     => '',
3938     'description' => "Don't use this.",
3939     'type'        => 'text',
3940   },
3941
3942   {
3943     'key'         => 'sg-ping_password',
3944     'section'     => '',
3945     'description' => "Don't use this.",
3946     'type'        => 'text',
3947   },
3948
3949   {
3950     'key'         => 'sg-login_username',
3951     'section'     => '',
3952     'description' => "Don't use this.",
3953     'type'        => 'text',
3954   },
3955
3956   {
3957     'key'         => 'mc-outbound_packages',
3958     'section'     => '',
3959     'description' => "Don't use this.",
3960     'type'        => 'select-part_pkg',
3961     'multiple'    => 1,
3962   },
3963
3964   {
3965     'key'         => 'disable-cust-pkg_class',
3966     'section'     => 'UI',
3967     'description' => 'Disable the two-step dropdown for selecting package class and package, and return to the classic single dropdown.',
3968     'type'        => 'checkbox',
3969   },
3970
3971   {
3972     'key'         => 'queued-max_kids',
3973     'section'     => '',
3974     'description' => 'Maximum number of queued processes.  Defaults to 10.',
3975     'type'        => 'text',
3976   },
3977
3978   {
3979     'key'         => 'queued-sleep_time',
3980     'section'     => '',
3981     '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.',
3982     'type'        => 'text',
3983   },
3984
3985   {
3986     'key'         => 'cancelled_cust-noevents',
3987     'section'     => 'billing',
3988     'description' => "Don't run events for cancelled customers",
3989     'type'        => 'checkbox',
3990   },
3991
3992   {
3993     'key'         => 'agent-invoice_template',
3994     'section'     => 'invoicing',
3995     'description' => 'Enable display/edit of old-style per-agent invoice template selection',
3996     'type'        => 'checkbox',
3997   },
3998
3999   {
4000     'key'         => 'svc_broadband-manage_link',
4001     'section'     => 'UI',
4002     'description' => 'URL for svc_broadband "Manage Device" link.  The following substitutions are available: $ip_addr.',
4003     'type'        => 'text',
4004   },
4005
4006   #more fine-grained, service def-level control could be useful eventually?
4007   {
4008     'key'         => 'svc_broadband-allow_null_ip_addr',
4009     'section'     => '',
4010     'description' => '',
4011     'type'        => 'checkbox',
4012   },
4013
4014   {
4015     'key'         => 'tax-report_groups',
4016     'section'     => '',
4017     'description' => 'List of grouping possibilities for tax names on reports, one per line, "label op value" (op can be = or !=).',
4018     'type'        => 'textarea',
4019   },
4020
4021   {
4022     'key'         => 'tax-cust_exempt-groups',
4023     'section'     => '',
4024     '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).',
4025     'type'        => 'textarea',
4026   },
4027
4028   {
4029     'key'         => 'cust_main-default_view',
4030     'section'     => 'UI',
4031     'description' => 'Default customer view, for users who have not selected a default view in their preferences.',
4032     'type'        => 'select',
4033     'select_hash' => [
4034       #false laziness w/view/cust_main.cgi and pref/pref.html
4035       'basics'          => 'Basics',
4036       'notes'           => 'Notes',
4037       'tickets'         => 'Tickets',
4038       'packages'        => 'Packages',
4039       'payment_history' => 'Payment History',
4040       'change_history'  => 'Change History',
4041       'jumbo'           => 'Jumbo',
4042     ],
4043   },
4044
4045   {
4046     'key'         => 'enable_tax_adjustments',
4047     'section'     => 'billing',
4048     'description' => 'Enable the ability to add manual tax adjustments.',
4049     'type'        => 'checkbox',
4050   },
4051
4052   {
4053     'key'         => 'rt-crontool',
4054     'section'     => '',
4055     'description' => 'Enable the RT CronTool extension.',
4056     'type'        => 'checkbox',
4057   },
4058
4059   {
4060     'key'         => 'pkg-balances',
4061     'section'     => 'billing',
4062     'description' => 'Enable experimental package balances.  Not recommended for general use.',
4063     'type'        => 'checkbox',
4064   },
4065
4066   {
4067     'key'         => 'pkg-addon_classnum',
4068     'section'     => 'billing',
4069     'description' => 'Enable the ability to restrict additional package orders based on package class.',
4070     'type'        => 'checkbox',
4071   },
4072
4073   {
4074     'key'         => 'cust_main-edit_signupdate',
4075     'section'     => 'UI',
4076     'descritpion' => 'Enable manual editing of the signup date.',
4077     'type'        => 'checkbox',
4078   },
4079
4080   {
4081     'key'         => 'svc_acct-disable_access_number',
4082     'section'     => 'UI',
4083     'descritpion' => 'Disable access number selection.',
4084     'type'        => 'checkbox',
4085   },
4086
4087   {
4088     'key'         => 'cust_bill_pay_pkg-manual',
4089     'section'     => 'UI',
4090     'description' => 'Allow manual application of payments to line items.',
4091     'type'        => 'checkbox',
4092   },
4093
4094   {
4095     'key'         => 'cust_credit_bill_pkg-manual',
4096     'section'     => 'UI',
4097     'description' => 'Allow manual application of credits to line items.',
4098     'type'        => 'checkbox',
4099   },
4100
4101   {
4102     'key'         => 'breakage-days',
4103     'section'     => 'billing',
4104     'description' => 'If set to a number of days, after an account goes that long without activity, recognizes any outstanding payments and credits as "breakage" by creating a breakage charge and invoice.',
4105     'type'        => 'text',
4106     'per_agent'   => 1,
4107   },
4108
4109   {
4110     'key'         => 'breakage-pkg_class',
4111     'section'     => 'billing',
4112     'description' => 'Package class to use for breakage reconciliation.',
4113     'type'        => 'select-pkg_class',
4114   },
4115
4116   {
4117     'key'         => 'disable_cron_billing',
4118     'section'     => 'billing',
4119     'description' => 'Disable billing and collection from being run by freeside-daily and freeside-monthly, while still allowing other actions to run, such as notifications and backup.',
4120     'type'        => 'checkbox',
4121   },
4122
4123   {
4124     'key'         => 'svc_domain-edit_domain',
4125     'section'     => '',
4126     'description' => 'Enable domain renaming',
4127     'type'        => 'checkbox',
4128   },
4129
4130   {
4131     'key'         => 'enable_legacy_prepaid_income',
4132     'section'     => '',
4133     '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.",
4134     'type'        => 'checkbox',
4135   },
4136
4137   {
4138     'key'         => 'cust_main-exports',
4139     'section'     => '',
4140     'description' => 'Export(s) to call on cust_main insert, modification and deletion.',
4141     'type'        => 'select-sub',
4142     'multiple'    => 1,
4143     'options_sub' => sub {
4144       require FS::Record;
4145       require FS::part_export;
4146       my @part_export =
4147         map { qsearch( 'part_export', {exporttype => $_ } ) }
4148           keys %{FS::part_export::export_info('cust_main')};
4149       map { $_->exportnum => $_->exporttype.' to '.$_->machine } @part_export;
4150     },
4151     'option_sub'  => sub {
4152       require FS::Record;
4153       require FS::part_export;
4154       my $part_export = FS::Record::qsearchs(
4155         'part_export', { 'exportnum' => shift }
4156       );
4157       $part_export
4158         ? $part_export->exporttype.' to '.$part_export->machine
4159         : '';
4160     },
4161   },
4162
4163   {
4164     'key'         => 'cust_tag-location',
4165     'section'     => 'UI',
4166     'description' => 'Location where customer tags are displayed.',
4167     'type'        => 'select',
4168     'select_enum' => [ 'misc_info', 'top' ],
4169   },
4170
4171   {
4172     'key'         => 'maestro-status_test',
4173     'section'     => 'UI',
4174     'description' => 'Display a link to the maestro status test page on the customer view page',
4175     'type'        => 'checkbox',
4176   },
4177
4178   {
4179     'key'         => 'cust_main-custom_link',
4180     'section'     => 'UI',
4181     'description' => 'URL to use as source for the "Custom" tab in the View Customer page.  The custnum will be appended.',
4182     'type'        => 'text',
4183   },
4184
4185   {
4186     'key'         => 'cust_main-custom_title',
4187     'section'     => 'UI',
4188     'description' => 'Title for the "Custom" tab in the View Customer page.',
4189     'type'        => 'text',
4190   },
4191
4192   {
4193     'key'         => 'part_pkg-default_suspend_bill',
4194     'section'     => 'billing',
4195     'description' => 'Default the "Continue recurring billing while suspended" flag to on for new package definitions.',
4196     'type'        => 'checkbox',
4197   },
4198
4199   {
4200     'key'         => 'qual-alt-address-format',
4201     'section'     => 'UI',
4202     'description' => 'Enable the alternate address format (location type, number, and kind) on qualifications',
4203     'type'        => 'checkbox',
4204   },
4205
4206   {
4207     'key'         => 'note-classes',
4208     'section'     => 'UI',
4209     'description' => 'Use customer note classes',
4210     'type'        => 'select',
4211     'select_hash' => [
4212                        0 => 'Disabled',
4213                        1 => 'Enabled',
4214                        2 => 'Enabled, with tabs',
4215                      ],
4216   },
4217
4218   {
4219     'key'         => 'svc_acct-cf_privatekey-message',
4220     'section'     => '',
4221     'description' => 'For internal use: HTML displayed when cf_privatekey field is set.',
4222     'type'        => 'textarea',
4223   },
4224
4225   {
4226     'key'         => 'menu-prepend_links',
4227     'section'     => 'UI',
4228     'description' => 'Links to prepend to the main menu, one per line, with format "URL Link Label (optional ALT popup)".',
4229     'type'        => 'textarea',
4230   },
4231
4232   {
4233     'key'         => 'cust_main-external_links',
4234     'section'     => 'UI',
4235     'description' => 'External links available in customer view, one per line, with format "URL Link Label (optional ALT popup)".  The URL will have custnum appended.',
4236     'type'        => 'textarea',
4237   },
4238
4239   {
4240     'key'         => 'svc_phone-did-summary',
4241     'section'     => 'invoicing',
4242     'description' => 'Enable DID activity summary for past 30 days on invoices, showing # DIDs activated/deactivated/ported-in/ported-out and total minutes usage',
4243     'type'        => 'checkbox',
4244   },
4245
4246   {
4247     'key'         => 'opensips_gwlist',
4248     'section'     => 'telephony',
4249     'description' => 'For svc_phone OpenSIPS dr_rules export, gwlist column value, per-agent',
4250     'type'        => 'text',
4251     'per_agent'   => 1,
4252     'agentonly'   => 1,
4253   },
4254
4255   {
4256     'key'         => 'opensips_description',
4257     'section'     => 'telephony',
4258     'description' => 'For svc_phone OpenSIPS dr_rules export, description column value, per-agent',
4259     'type'        => 'text',
4260     'per_agent'   => 1,
4261     'agentonly'   => 1,
4262   },
4263
4264   {
4265     'key'         => 'opensips_route',
4266     'section'     => 'telephony',
4267     'description' => 'For svc_phone OpenSIPS dr_rules export, routeid column value, per-agent',
4268     'type'        => 'text',
4269     'per_agent'   => 1,
4270     'agentonly'   => 1,
4271   },
4272
4273   {
4274     'key'         => 'cust_bill-no_recipients-error',
4275     'section'     => 'invoicing',
4276     '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.',
4277     'type'        => 'checkbox',
4278   },
4279
4280   {
4281     'key'         => 'cust_main-status_module',
4282     'section'     => 'UI',
4283     '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?
4284     'type'        => 'select',
4285     'select_enum' => [ 'Classic', 'Recurring' ],
4286   },
4287
4288   {
4289     'key'         => 'username-pound',
4290     'section'     => 'username',
4291     'description' => 'Allow the pound character (#) in usernames.',
4292     'type'        => 'checkbox',
4293   },
4294
4295   { key => "apacheroot", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4296   { key => "apachemachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4297   { key => "apachemachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4298   { key => "bindprimary", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4299   { key => "bindsecondaries", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4300   { key => "bsdshellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4301   { key => "cyrus", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4302   { key => "cp_app", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4303   { key => "erpcdmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4304   { key => "icradiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4305   { key => "icradius_mysqldest", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4306   { key => "icradius_mysqlsource", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4307   { key => "icradius_secrets", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4308   { key => "maildisablecatchall", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4309   { key => "mxmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4310   { key => "nsmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4311   { key => "arecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4312   { key => "cnamerecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4313   { key => "nismachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4314   { key => "qmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4315   { key => "radiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4316   { key => "sendmailconfigpath", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4317   { key => "sendmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4318   { key => "sendmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4319   { key => "shellmachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4320   { key => "shellmachine-useradd", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4321   { key => "shellmachine-userdel", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4322   { key => "shellmachine-usermod", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4323   { key => "shellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4324   { key => "radiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4325   { key => "textradiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4326   { key => "username_policy", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4327   { key => "vpopmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4328   { key => "vpopmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4329   { key => "safe-part_pkg", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4330   { key => "selfservice_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4331   { key => "signup_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4332   { key => "signup_server-email", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4333   { key => "vonage-username", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4334   { key => "vonage-password", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4335   { key => "vonage-fromnumber", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4336
4337 );
4338
4339 1;
4340