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     $error .= "$key fails binary comparison; "
 399       unless scalar($self->config_binary($key)) eq scalar($compat->config_binary($key));
 400
 401   }
 402
 403 #remove deprecated config on our own terms, not freeside-upgrade's
 404 #  if ($error =~ /existential comparison/ && $item->section eq 'deprecated') {
 405 #    my $proto;
 406 #    for ( @config_items ) { $proto = $_; last if $proto->key eq $key;  }
 407 #    unless ($proto->key eq $key) {
 408 #      warn "removed config item $error\n" if $DEBUG;
 409 #      $error = '';
 410 #    }
 411 #  }
 412
 413   $error;
 414 }
 415
 416 #item _orbase_items OPTIONS
 417 #
 418 #Returns all of the possible extensible config items as FS::ConfItem objects.
 419 #See #L<FS::ConfItem>.  OPTIONS consists of name value pairs.  Possible
 420 #options include
 421 #
 422 # dir - the directory to search for configuration option files instead
 423 #       of using the conf records in the database
 424 #
 425 #cut
 426
 427 #quelle kludge
 428 sub _orbase_items {
 429   my ($self, %opt) = @_;
 430
 431   my $listmaker = sub { my $v = shift;
 432                         $v =~ s/_/!_/g;
 433                         if ( $v =~ /\.(png|eps)$/ ) {
 434                           $v =~ s/\./!_%./;
 435                         }else{
 436                           $v .= '!_%';
 437                         }
 438                         map { $_->name }
 439                           FS::Record::qsearch( 'conf',
 440                                                {},
 441                                                '',
 442                                                "WHERE name LIKE '$v' ESCAPE '!'"
 443                                              );
 444                       };
 445
 446   if (exists($opt{dir}) && $opt{dir}) {
 447     $listmaker = sub { my $v = shift;
 448                        if ( $v =~ /\.(png|eps)$/ ) {
 449                          $v =~ s/\./_*./;
 450                        }else{
 451                          $v .= '_*';
 452                        }
 453                        map { basename $_ } glob($opt{dir}. "/$v" );
 454                      };
 455   }
 456
 457   ( map {
 458           my $proto;
 459           my $base = $_;
 460           for ( @config_items ) { $proto = $_; last if $proto->key eq $base;  }
 461           die "don't know about $base items" unless $proto->key eq $base;
 462
 463           map { new FS::ConfItem {
 464                   'key'         => $_,
 465                   'base_key'    => $proto->key,
 466                   'section'     => $proto->section,
 467                   'description' => 'Alternate ' . $proto->description . '  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.7:Documentation:Administration#Invoice_templates">billing documentation</a> for details.',
 468                   'type'        => $proto->type,
 469                 };
 470               } &$listmaker($base);
 471         } @base_items,
 472   );
 473 }
 474
 475 =item config_items
 476
 477 Returns all of the possible global/default configuration items as
 478 FS::ConfItem objects.  See L<FS::ConfItem>.
 479
 480 =cut
 481
 482 sub config_items {
 483   my $self = shift;
 484   return $self->_usecompat('config_items', @_) if use_confcompat;
 485
 486   ( @config_items, $self->_orbase_items(@_) );
 487 }
 488
 489 =back
 490
 491 =head1 SUBROUTINES
 492
 493 =over 4
 494
 495 =item init-config DIR
 496
 497 Imports the configuration items from DIR (1.7 compatible)
 498 to conf records in the database.
 499
 500 =cut
 501
 502 sub init_config {
 503   my $dir = shift;
 504
 505   {
 506     local $FS::UID::use_confcompat = 0;
 507     my $conf = new FS::Conf;
 508     foreach my $item ( $conf->config_items(dir => $dir) ) {
 509       $conf->import_config_item($item, $dir);
 510       my $error = $conf->verify_config_item($item, $dir);
 511       return $error if $error;
 512     }
 513
 514     my $compat = new FS::Conf_compat17 $dir;
 515     foreach my $item ( $compat->config_items ) {
 516       my $error = $conf->verify_config_item($item, $dir);
 517       return $error if $error;
 518     }
 519   }
 520
 521   $FS::UID::use_confcompat = 0;
 522   '';  #success
 523 }
 524
 525 =back
 526
 527 =head1 BUGS
 528
 529 If this was more than just crud that will never be useful outside Freeside I'd
 530 worry that config_items is freeside-specific and icky.
 531
 532 =head1 SEE ALSO
 533
 534 "Configuration" in the web interface (config/config.cgi).
 535
 536 =cut
 537
 538 #Business::CreditCard
 539 @card_types = (
 540   "VISA card",
 541   "MasterCard",
 542   "Discover card",
 543   "American Express card",
 544   "Diner's Club/Carte Blanche",
 545   "enRoute",
 546   "JCB",
 547   "BankCard",
 548   "Switch",
 549   "Solo",
 550 );
 551
 552 @base_items = qw (
 553                    invoice_template
 554                    invoice_latex
 555                    invoice_latexreturnaddress
 556                    invoice_latexfooter
 557                    invoice_latexsmallfooter
 558                    invoice_latexnotes
 559                    invoice_latexcoupon
 560                    invoice_html
 561                    invoice_htmlreturnaddress
 562                    invoice_htmlfooter
 563                    invoice_htmlnotes
 564                    logo.png
 565                    logo.eps
 566                  );
 567
 568 #Billing (81 items)
 569 #Invoicing (50 items)
 570 #UI (69 items)
 571 #Self-service (29 items)
 572 #...
 573 #Unclassified (77 items)
 574
 575
 576 @config_items = map { new FS::ConfItem $_ } (
 577
 578   {
 579     'key'         => 'address',
 580     'section'     => 'deprecated',
 581     'description' => 'This configuration option is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.',
 582     'type'        => 'text',
 583   },
 584
 585   {
 586     'key'         => 'alert_expiration',
 587     'section'     => 'billing',
 588     'description' => 'Enable alerts about billing method expiration (i.e. expiring credit cards).',
 589     'type'        => 'checkbox',
 590     'per_agent'   => 1,
 591   },
 592
 593   {
 594     'key'         => 'alerter_template',
 595     'section'     => 'billing',
 596     'description' => 'Template file for billing method expiration alerts (i.e. expiring credit cards).  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.7:Documentation:Administration#Credit_cards_and_Electronic_checks">billing documentation</a> for details.',
 597     'type'        => 'textarea',
 598     'per_agent'   => 1,
 599   },
 600
 601   {
 602     'key'         => 'apacheip',
 603     #not actually deprecated yet
 604     #'section'     => 'deprecated',
 605     #'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',
 606     'section'     => '',
 607     'description' => 'IP address to assign to new virtual hosts',
 608     'type'        => 'text',
 609   },
 610
 611   {
 612     'key'         => 'encryption',
 613     'section'     => 'billing',
 614     'description' => 'Enable encryption of credit cards.',
 615     'type'        => 'checkbox',
 616   },
 617
 618   {
 619     'key'         => 'encryptionmodule',
 620     'section'     => 'billing',
 621     'description' => 'Use which module for encryption?',
 622     'type'        => 'text',
 623   },
 624
 625   {
 626     'key'         => 'encryptionpublickey',
 627     'section'     => 'billing',
 628     'description' => 'Your RSA Public Key - Required if Encryption is turned on.',
 629     'type'        => 'textarea',
 630   },
 631
 632   {
 633     'key'         => 'encryptionprivatekey',
 634     'section'     => 'billing',
 635     '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.',
 636     'type'        => 'textarea',
 637   },
 638
 639   {
 640     'key'         => 'billco-url',
 641     'section'     => 'billing',
 642     'description' => 'The url to use for performing uploads to the invoice mailing service.',
 643     'type'        => 'text',
 644     'per_agent'   => 1,
 645   },
 646
 647   {
 648     'key'         => 'billco-username',
 649     'section'     => 'billing',
 650     'description' => 'The login name to use for uploads to the invoice mailing service.',
 651     'type'        => 'text',
 652     'per_agent'   => 1,
 653     'agentonly'   => 1,
 654   },
 655
 656   {
 657     'key'         => 'billco-password',
 658     'section'     => 'billing',
 659     'description' => 'The password to use for uploads to the invoice mailing service.',
 660     'type'        => 'text',
 661     'per_agent'   => 1,
 662     'agentonly'   => 1,
 663   },
 664
 665   {
 666     'key'         => 'billco-clicode',
 667     'section'     => 'billing',
 668     'description' => 'The clicode to use for uploads to the invoice mailing service.',
 669     'type'        => 'text',
 670     'per_agent'   => 1,
 671   },
 672
 673   {
 674     'key'         => 'business-onlinepayment',
 675     'section'     => 'billing',
 676     '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.',
 677     'type'        => 'textarea',
 678   },
 679
 680   {
 681     'key'         => 'business-onlinepayment-ach',
 682     'section'     => 'billing',
 683     '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.',
 684     'type'        => 'textarea',
 685   },
 686
 687   {
 688     'key'         => 'business-onlinepayment-namespace',
 689     'section'     => 'billing',
 690     'description' => 'Specifies which perl module namespace (which group of collection routines) is used by default.',
 691     'type'        => 'select',
 692     'select_hash' => [
 693                        'Business::OnlinePayment' => 'Direct API (Business::OnlinePayment)',
 694                        'Business::OnlineThirdPartyPayment' => 'Web API (Business::ThirdPartyPayment)',
 695                      ],
 696   },
 697
 698   {
 699     'key'         => 'business-onlinepayment-description',
 700     'section'     => 'billing',
 701     '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)',
 702     'type'        => 'text',
 703   },
 704
 705   {
 706     'key'         => 'business-onlinepayment-email-override',
 707     'section'     => 'billing',
 708     'description' => 'Email address used instead of customer email address when submitting a BOP transaction.',
 709     'type'        => 'text',
 710   },
 711
 712   {
 713     'key'         => 'business-onlinepayment-email_customer',
 714     'section'     => 'billing',
 715     'description' => 'Controls the "email_customer" flag used by some Business::OnlinePayment processors to enable customer receipts.',
 716     'type'        => 'checkbox',
 717   },
 718
 719   {
 720     'key'         => 'business-onlinepayment-test_transaction',
 721     'section'     => 'billing',
 722     '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.',
 723     'type'        => 'checkbox',
 724   },
 725
 726   {
 727     'key'         => 'countrydefault',
 728     'section'     => 'UI',
 729     'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
 730     'type'        => 'text',
 731   },
 732
 733   {
 734     'key'         => 'date_format',
 735     'section'     => 'UI',
 736     'description' => 'Format for displaying dates',
 737     'type'        => 'select',
 738     'select_hash' => [
 739                        '%m/%d/%Y' => 'MM/DD/YYYY',
 740                        '%d/%m/%Y' => 'DD/MM/YYYY',
 741                        '%Y/%m/%d' => 'YYYY/MM/DD',
 742                      ],
 743   },
 744
 745   {
 746     'key'         => 'deletecustomers',
 747     'section'     => 'UI',
 748     '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.',
 749     'type'        => 'checkbox',
 750   },
 751
 752   {
 753     'key'         => 'deleteinvoices',
 754     'section'     => 'UI',
 755     '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?
 756     'type'        => 'checkbox',
 757   },
 758
 759   {
 760     'key'         => 'deletepayments',
 761     'section'     => 'billing',
 762     '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.',
 763     'type'        => [qw( checkbox text )],
 764   },
 765
 766   {
 767     'key'         => 'deletecredits',
 768     #not actually deprecated yet
 769     #'section'     => 'deprecated',
 770     #'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.',
 771     'section'     => '',
 772     'description' => 'One or more comma-separated email addresses to be notified when a credit is deleted.',
 773     'type'        => [qw( checkbox text )],
 774   },
 775
 776   {
 777     'key'         => 'deleterefunds',
 778     'section'     => 'billing',
 779     'description' => 'Enable deletion of unclosed refunds.  Be very careful!  Only delete refunds that were data-entry errors, not adjustments.',
 780     'type'        => 'checkbox',
 781   },
 782
 783   {
 784     'key'         => 'unapplypayments',
 785     'section'     => 'deprecated',
 786     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable "unapplication" of unclosed payments.',
 787     'type'        => 'checkbox',
 788   },
 789
 790   {
 791     'key'         => 'unapplycredits',
 792     'section'     => 'deprecated',
 793     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to nable "unapplication" of unclosed credits.',
 794     'type'        => 'checkbox',
 795   },
 796
 797   {
 798     'key'         => 'dirhash',
 799     'section'     => 'shell',
 800     '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>',
 801     'type'        => 'text',
 802   },
 803
 804   {
 805     'key'         => 'disable_cust_attachment',
 806     'section'     => '',
 807     'description' => 'Disable customer file attachments',
 808     'type'        => 'checkbox',
 809   },
 810
 811   {
 812     'key'         => 'max_attachment_size',
 813     'section'     => '',
 814     'description' => 'Maximum size for customer file attachments (leave blank for unlimited)',
 815     'type'        => 'text',
 816   },
 817
 818   {
 819     'key'         => 'disable_customer_referrals',
 820     'section'     => 'UI',
 821     'description' => 'Disable new customer-to-customer referrals in the web interface',
 822     'type'        => 'checkbox',
 823   },
 824
 825   {
 826     'key'         => 'editreferrals',
 827     'section'     => 'UI',
 828     'description' => 'Enable advertising source modification for existing customers',
 829     'type'        => 'checkbox',
 830   },
 831
 832   {
 833     'key'         => 'emailinvoiceonly',
 834     'section'     => 'invoicing',
 835     'description' => 'Disables postal mail invoices',
 836     'type'        => 'checkbox',
 837   },
 838
 839   {
 840     'key'         => 'disablepostalinvoicedefault',
 841     'section'     => 'invoicing',
 842     '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>.',
 843     'type'        => 'checkbox',
 844   },
 845
 846   {
 847     'key'         => 'emailinvoiceauto',
 848     'section'     => 'invoicing',
 849     'description' => 'Automatically adds new accounts to the email invoice list',
 850     'type'        => 'checkbox',
 851   },
 852
 853   {
 854     'key'         => 'emailinvoiceautoalways',
 855     'section'     => 'invoicing',
 856     'description' => 'Automatically adds new accounts to the email invoice list even when the list contains email addresses',
 857     'type'        => 'checkbox',
 858   },
 859
 860   {
 861     'key'         => 'emailinvoice-apostrophe',
 862     'section'     => 'invoicing',
 863     'description' => 'Allows the apostrophe (single quote) character in the email addresses in the email invoice list.',
 864     'type'        => 'checkbox',
 865   },
 866
 867   {
 868     'key'         => 'exclude_ip_addr',
 869     'section'     => '',
 870     'description' => 'Exclude these from the list of available broadband service IP addresses. (One per line)',
 871     'type'        => 'textarea',
 872   },
 873
 874   {
 875     'key'         => 'auto_router',
 876     'section'     => '',
 877     'description' => 'Automatically choose the correct router/block based on supplied ip address when possible while provisioning broadband services',
 878     'type'        => 'checkbox',
 879   },
 880
 881   {
 882     'key'         => 'hidecancelledpackages',
 883     'section'     => 'UI',
 884     'description' => 'Prevent cancelled packages from showing up in listings (though they will still be in the database)',
 885     'type'        => 'checkbox',
 886   },
 887
 888   {
 889     'key'         => 'hidecancelledcustomers',
 890     'section'     => 'UI',
 891     'description' => 'Prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
 892     'type'        => 'checkbox',
 893   },
 894
 895   {
 896     'key'         => 'home',
 897     'section'     => 'shell',
 898     'description' => 'For new users, prefixed to username to create a directory name.  Should have a leading but not a trailing slash.',
 899     'type'        => 'text',
 900   },
 901
 902   {
 903     'key'         => 'invoice_from',
 904     'section'     => 'required',
 905     'description' => 'Return address on email invoices',
 906     'type'        => 'text',
 907     'per_agent'   => 1,
 908   },
 909
 910   {
 911     'key'         => 'invoice_subject',
 912     'section'     => 'invoicing',
 913     'description' => 'Subject: header on email invoices.  Defaults to "Invoice".  The following substitutions are available: $name, $name_short, $invoice_number, and $invoice_date.',
 914     'type'        => 'text',
 915     'per_agent'   => 1,
 916   },
 917
 918   {
 919     'key'         => 'invoice_usesummary',
 920     'section'     => 'invoicing',
 921     'description' => 'Indicates that html and latex invoices should be in summary style and make use of invoice_latexsummary.',
 922     'type'        => 'checkbox',
 923   },
 924
 925   {
 926     'key'         => 'invoice_template',
 927     'section'     => 'invoicing',
 928     '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:1.7:Documentation:Administration#Plaintext_invoice_templates">billing documentation</a> for details.',
 929     'type'        => 'textarea',
 930   },
 931
 932   {
 933     'key'         => 'invoice_html',
 934     'section'     => 'invoicing',
 935     'description' => 'Optional HTML template for invoices.  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.7:Documentation:Administration#HTML_invoice_templates">billing documentation</a> for details.',
 936
 937     'type'        => 'textarea',
 938   },
 939
 940   {
 941     'key'         => 'invoice_htmlnotes',
 942     'section'     => 'invoicing',
 943     'description' => 'Notes section for HTML invoices.  Defaults to the same data in invoice_latexnotes if not specified.',
 944     'type'        => 'textarea',
 945     'per_agent'   => 1,
 946   },
 947
 948   {
 949     'key'         => 'invoice_htmlfooter',
 950     'section'     => 'invoicing',
 951     'description' => 'Footer for HTML invoices.  Defaults to the same data in invoice_latexfooter if not specified.',
 952     'type'        => 'textarea',
 953     'per_agent'   => 1,
 954   },
 955
 956   {
 957     'key'         => 'invoice_htmlsummary',
 958     'section'     => 'invoicing',
 959     'description' => 'Summary initial page for HTML invoices.',
 960     'type'        => 'textarea',
 961     'per_agent'   => 1,
 962   },
 963
 964   {
 965     'key'         => 'invoice_htmlreturnaddress',
 966     'section'     => 'invoicing',
 967     'description' => 'Return address for HTML invoices.  Defaults to the same data in invoice_latexreturnaddress if not specified.',
 968     'type'        => 'textarea',
 969   },
 970
 971   {
 972     'key'         => 'invoice_latex',
 973     'section'     => 'invoicing',
 974     'description' => 'Optional LaTeX template for typeset PostScript invoices.  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.7:Documentation:Administration#Typeset_.28LaTeX.29_invoice_templates">billing documentation</a> for details.',
 975     'type'        => 'textarea',
 976   },
 977
 978   {
 979     'key'         => 'invoice_latexnotes',
 980     'section'     => 'invoicing',
 981     'description' => 'Notes section for LaTeX typeset PostScript invoices.',
 982     'type'        => 'textarea',
 983     'per_agent'   => 1,
 984   },
 985
 986   {
 987     'key'         => 'invoice_latexfooter',
 988     'section'     => 'invoicing',
 989     'description' => 'Footer for LaTeX typeset PostScript invoices.',
 990     'type'        => 'textarea',
 991     'per_agent'   => 1,
 992   },
 993
 994   {
 995     'key'         => 'invoice_latexsummary',
 996     'section'     => 'invoicing',
 997     'description' => 'Summary initial page for LaTeX typeset PostScript invoices.',
 998     'type'        => 'textarea',
 999     'per_agent'   => 1,
1000   },
1001
1002   {
1003     'key'         => 'invoice_latexcoupon',
1004     'section'     => 'invoicing',
1005     'description' => 'Remittance coupon for LaTeX typeset PostScript invoices.',
1006     'type'        => 'textarea',
1007     'per_agent'   => 1,
1008   },
1009
1010   {
1011     'key'         => 'invoice_latexreturnaddress',
1012     'section'     => 'invoicing',
1013     'description' => 'Return address for LaTeX typeset PostScript invoices.',
1014     'type'        => 'textarea',
1015   },
1016
1017   {
1018     'key'         => 'invoice_latexsmallfooter',
1019     'section'     => 'invoicing',
1020     'description' => 'Optional small footer for multi-page LaTeX typeset PostScript invoices.',
1021     'type'        => 'textarea',
1022     'per_agent'   => 1,
1023   },
1024
1025   {
1026     'key'         => 'invoice_email_pdf',
1027     'section'     => 'invoicing',
1028     '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.',
1029     'type'        => 'checkbox'
1030   },
1031
1032   {
1033     'key'         => 'invoice_email_pdf_note',
1034     'section'     => 'invoicing',
1035     'description' => 'If defined, this text will replace the default plain text invoice as the body of emailed PDF invoices.',
1036     'type'        => 'textarea'
1037   },
1038
1039
1040   {
1041     'key'         => 'invoice_default_terms',
1042     'section'     => 'invoicing',
1043     'description' => 'Optional default invoice term, used to calculate a due date printed on invoices.',
1044     'type'        => 'select',
1045     'select_enum' => [ '', 'Payable upon receipt', 'Net 0', 'Net 10', 'Net 15', 'Net 20', 'Net 30', 'Net 45', 'Net 60' ],
1046   },
1047
1048   {
1049     'key'         => 'invoice_show_prior_due_date',
1050     'section'     => 'invoicing',
1051     'description' => 'Show previous invoice due dates when showing prior balances.  Default is to show invoice date.',
1052     'type'        => 'checkbox',
1053   },
1054
1055   {
1056     'key'         => 'invoice_include_aging',
1057     'section'     => 'invoicing',
1058     'description' => 'Show an aging line after the prior balance section.  Only valud when invoice_sections is enabled.',
1059     'type'        => 'checkbox',
1060   },
1061
1062   {
1063     'key'         => 'invoice_sections',
1064     'section'     => 'invoicing',
1065     'description' => 'Split invoice into sections and label according to package category when enabled.',
1066     'type'        => 'checkbox',
1067   },
1068
1069   {
1070     'key'         => 'usage_class_as_a_section',
1071     'section'     => 'invoicing',
1072     'description' => 'Split usage into sections and label according to usage class name when enabled.  Only valid when invoice_sections is enabled.',
1073     'type'        => 'checkbox',
1074   },
1075
1076   {
1077     'key'         => 'svc_phone_sections',
1078     'section'     => 'invoicing',
1079     'description' => 'Create a section for each svc_phone when enabled.  Only valid when invoice_sections is enabled.',
1080     'type'        => 'checkbox',
1081   },
1082
1083   {
1084     'key'         => 'finance_pkgclass',
1085     'section'     => 'billing',
1086     'description' => 'The default package class for late fee charges, used if the fee event does not specify a package class itself.',
1087     'type'        => 'select-pkg_class',
1088   },
1089
1090   {
1091     'key'         => 'separate_usage',
1092     'section'     => 'invoicing',
1093     'description' => 'Split the rated call usage into a separate line from the recurring charges.',
1094     'type'        => 'checkbox',
1095   },
1096
1097   {
1098     'key'         => 'invoice_send_receipts',
1099     'section'     => 'deprecated',
1100     'description' => '<b>DEPRECATED</b>, this used to send an invoice copy on payments and credits.  See the payment_receipt_email and XXXX instead.',
1101     'type'        => 'checkbox',
1102   },
1103
1104   {
1105     'key'         => 'payment_receipt_email',
1106     'section'     => 'billing',
1107     'description' => 'Template file for payment receipts.  Payment receipts are sent to the customer email invoice destination(s) when a payment is received.  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>$date</code> <li><code>$name</code> <li><code>$paynum</code> - Freeside payment number <li><code>$paid</code> - Amount of payment <li><code>$payby</code> - Payment type (Card, Check, Electronic check, etc.) <li><code>$payinfo</code> - Masked credit card number or check number <li><code>$balance</code> - New balance<li><code>$pkg</code> - Package (requires payment_receipt-trigger set to "when payment is applied".)</ul>',
1108     'type'        => [qw( checkbox textarea )],
1109   },
1110
1111   {
1112     'key'         => 'payment_receipt-trigger',
1113     'section'     => 'billing',
1114     'description' => 'When payment receipts are triggered.  Defaults to when payment is made.',
1115     'type'        => 'select',
1116     'select_hash' => [
1117                        'cust_pay'          => 'When payment is made.',
1118                        'cust_bill_pay_pkg' => 'When payment is applied.',
1119                      ],
1120   },
1121
1122   {
1123     'key'         => 'trigger_export_insert_on_payment',
1124     'section'     => 'billing',
1125     'description' => 'Enable exports on payment application.',
1126     'type'        => 'checkbox',
1127   },
1128
1129   {
1130     'key'         => 'lpr',
1131     'section'     => 'required',
1132     'description' => 'Print command for paper invoices, for example `lpr -h\'',
1133     'type'        => 'text',
1134   },
1135
1136   {
1137     'key'         => 'lpr-postscript_prefix',
1138     'section'     => 'billing',
1139     'description' => 'Raw printer commands prepended to the beginning of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1140     'type'        => 'text',
1141   },
1142
1143   {
1144     'key'         => 'lpr-postscript_suffix',
1145     'section'     => 'billing',
1146     'description' => 'Raw printer commands added to the end of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1147     'type'        => 'text',
1148   },
1149
1150   {
1151     'key'         => 'money_char',
1152     'section'     => '',
1153     'description' => 'Currency symbol - defaults to `$\'',
1154     'type'        => 'text',
1155   },
1156
1157   {
1158     'key'         => 'defaultrecords',
1159     'section'     => 'BIND',
1160     'description' => 'DNS entries to add automatically when creating a domain',
1161     'type'        => 'editlist',
1162     'editlist_parts' => [ { type=>'text' },
1163                           { type=>'immutable', value=>'IN' },
1164                           { type=>'select',
1165                             select_enum=>{ map { $_=>$_ } qw(A CNAME MX NS TXT)} },
1166                           { type=> 'text' }, ],
1167   },
1168
1169   {
1170     'key'         => 'passwordmin',
1171     'section'     => 'password',
1172     'description' => 'Minimum password length (default 6)',
1173     'type'        => 'text',
1174   },
1175
1176   {
1177     'key'         => 'passwordmax',
1178     'section'     => 'password',
1179     'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
1180     'type'        => 'text',
1181   },
1182
1183   {
1184     'key'         => 'password-noampersand',
1185     'section'     => 'password',
1186     'description' => 'Disallow ampersands in passwords',
1187     'type'        => 'checkbox',
1188   },
1189
1190   {
1191     'key'         => 'password-noexclamation',
1192     'section'     => 'password',
1193     'description' => 'Disallow exclamations in passwords (Not setting this could break old text Livingston or Cistron Radius servers)',
1194     'type'        => 'checkbox',
1195   },
1196
1197   {
1198     'key'         => 'default-password-encoding',
1199     'section'     => 'password',
1200     'description' => 'Default storage format for passwords',
1201     'type'        => 'select',
1202     'select_hash' => [
1203       'plain'       => 'Plain text',
1204       'crypt-des'   => 'Unix password (DES encrypted)',
1205       'crypt-md5'   => 'Unix password (MD5 digest)',
1206       'ldap-plain'  => 'LDAP (plain text)',
1207       'ldap-crypt'  => 'LDAP (DES encrypted)',
1208       'ldap-md5'    => 'LDAP (MD5 digest)',
1209       'ldap-sha1'   => 'LDAP (SHA1 digest)',
1210       'legacy'      => 'Legacy mode',
1211     ],
1212   },
1213
1214   {
1215     'key'         => 'referraldefault',
1216     'section'     => 'UI',
1217     'description' => 'Default referral, specified by refnum',
1218     'type'        => 'text',
1219   },
1220
1221 #  {
1222 #    'key'         => 'registries',
1223 #    'section'     => 'required',
1224 #    'description' => 'Directory which contains domain registry information.  Each registry is a directory.',
1225 #  },
1226
1227   {
1228     'key'         => 'report_template',
1229     'section'     => 'deprecated',
1230     'description' => 'Deprecated template file for reports.',
1231     'type'        => 'textarea',
1232   },
1233
1234   {
1235     'key'         => 'maxsearchrecordsperpage',
1236     'section'     => 'UI',
1237     'description' => 'If set, number of search records to return per page.',
1238     'type'        => 'text',
1239   },
1240
1241   {
1242     'key'         => 'session-start',
1243     'section'     => 'session',
1244     '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.',
1245     'type'        => 'text',
1246   },
1247
1248   {
1249     'key'         => 'session-stop',
1250     'section'     => 'session',
1251     '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.',
1252     'type'        => 'text',
1253   },
1254
1255   {
1256     'key'         => 'shells',
1257     'section'     => 'shell',
1258     '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.',
1259     'type'        => 'textarea',
1260   },
1261
1262   {
1263     'key'         => 'showpasswords',
1264     'section'     => 'UI',
1265     'description' => 'Display unencrypted user passwords in the backend (employee) web interface',
1266     'type'        => 'checkbox',
1267   },
1268
1269   {
1270     'key'         => 'report-showpasswords',
1271     'section'     => 'UI',
1272     'description' => 'This is a terrible idea.  Do not enable it.  STRONGLY NOT RECOMMENDED.  Enables display of passwords on services reports.',
1273     'type'        => 'checkbox',
1274   },
1275
1276   {
1277     'key'         => 'signupurl',
1278     'section'     => 'UI',
1279     '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:1.7: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',
1280     'type'        => 'text',
1281   },
1282
1283   {
1284     'key'         => 'smtpmachine',
1285     'section'     => 'required',
1286     'description' => 'SMTP relay for Freeside\'s outgoing mail',
1287     'type'        => 'text',
1288   },
1289
1290   {
1291     'key'         => 'smtp-username',
1292     'section'     => '',
1293     'description' => 'Optional SMTP username for Freeside\'s outgoing mail',
1294     'type'        => 'text',
1295   },
1296
1297   {
1298     'key'         => 'smtp-password',
1299     'section'     => '',
1300     'description' => 'Optional SMTP password for Freeside\'s outgoing mail',
1301     'type'        => 'text',
1302   },
1303
1304   {
1305     'key'         => 'smtp-encryption',
1306     'section'     => '',
1307     'description' => 'Optional SMTP encryption method.  The STARTTLS methods require smtp-username and smtp-password to be set.',
1308     'type'        => 'select',
1309     'select_hash' => [ '25'           => 'None (port 25)',
1310                        '25-starttls'  => 'STARTTLS (port 25)',
1311                        '587-starttls' => 'STARTTLS / submission (port 587)',
1312                        '465-tls'      => 'SMTPS (SSL) (port 465)',
1313                      ],
1314   },
1315
1316   {
1317     'key'         => 'soadefaultttl',
1318     'section'     => 'BIND',
1319     'description' => 'SOA default TTL for new domains.',
1320     'type'        => 'text',
1321   },
1322
1323   {
1324     'key'         => 'soaemail',
1325     'section'     => 'BIND',
1326     'description' => 'SOA email for new domains, in BIND form (`.\' instead of `@\'), with trailing `.\'',
1327     'type'        => 'text',
1328   },
1329
1330   {
1331     'key'         => 'soaexpire',
1332     'section'     => 'BIND',
1333     'description' => 'SOA expire for new domains',
1334     'type'        => 'text',
1335   },
1336
1337   {
1338     'key'         => 'soamachine',
1339     'section'     => 'BIND',
1340     'description' => 'SOA machine for new domains, with trailing `.\'',
1341     'type'        => 'text',
1342   },
1343
1344   {
1345     'key'         => 'soarefresh',
1346     'section'     => 'BIND',
1347     'description' => 'SOA refresh for new domains',
1348     'type'        => 'text',
1349   },
1350
1351   {
1352     'key'         => 'soaretry',
1353     'section'     => 'BIND',
1354     'description' => 'SOA retry for new domains',
1355     'type'        => 'text',
1356   },
1357
1358   {
1359     'key'         => 'statedefault',
1360     'section'     => 'UI',
1361     'description' => 'Default state or province (if not supplied, the default is `CA\')',
1362     'type'        => 'text',
1363   },
1364
1365   {
1366     'key'         => 'unsuspendauto',
1367     'section'     => 'billing',
1368     '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',
1369     'type'        => 'checkbox',
1370   },
1371
1372   {
1373     'key'         => 'unsuspend-always_adjust_next_bill_date',
1374     'section'     => 'billing',
1375     '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.',
1376     'type'        => 'checkbox',
1377   },
1378
1379   {
1380     'key'         => 'usernamemin',
1381     'section'     => 'username',
1382     'description' => 'Minimum username length (default 2)',
1383     'type'        => 'text',
1384   },
1385
1386   {
1387     'key'         => 'usernamemax',
1388     'section'     => 'username',
1389     'description' => 'Maximum username length',
1390     'type'        => 'text',
1391   },
1392
1393   {
1394     'key'         => 'username-ampersand',
1395     'section'     => 'username',
1396     '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.',
1397     'type'        => 'checkbox',
1398   },
1399
1400   {
1401     'key'         => 'username-letter',
1402     'section'     => 'username',
1403     'description' => 'Usernames must contain at least one letter',
1404     'type'        => 'checkbox',
1405     'per_agent'   => 1,
1406   },
1407
1408   {
1409     'key'         => 'username-letterfirst',
1410     'section'     => 'username',
1411     'description' => 'Usernames must start with a letter',
1412     'type'        => 'checkbox',
1413   },
1414
1415   {
1416     'key'         => 'username-noperiod',
1417     'section'     => 'username',
1418     'description' => 'Disallow periods in usernames',
1419     'type'        => 'checkbox',
1420   },
1421
1422   {
1423     'key'         => 'username-nounderscore',
1424     'section'     => 'username',
1425     'description' => 'Disallow underscores in usernames',
1426     'type'        => 'checkbox',
1427   },
1428
1429   {
1430     'key'         => 'username-nodash',
1431     'section'     => 'username',
1432     'description' => 'Disallow dashes in usernames',
1433     'type'        => 'checkbox',
1434   },
1435
1436   {
1437     'key'         => 'username-uppercase',
1438     'section'     => 'username',
1439     'description' => 'Allow uppercase characters in usernames.  Not recommended for use with FreeRADIUS with MySQL backend, which is case-insensitive by default.',
1440     'type'        => 'checkbox',
1441   },
1442
1443   {
1444     'key'         => 'username-percent',
1445     'section'     => 'username',
1446     'description' => 'Allow the percent character (%) in usernames.',
1447     'type'        => 'checkbox',
1448   },
1449
1450   {
1451     'key'         => 'username-colon',
1452     'section'     => 'username',
1453     'description' => 'Allow the colon character (:) in usernames.',
1454     'type'        => 'checkbox',
1455   },
1456
1457   {
1458     'key'         => 'safe-part_bill_event',
1459     'section'     => 'UI',
1460     'description' => 'Validates invoice event expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
1461     'type'        => 'checkbox',
1462   },
1463
1464   {
1465     'key'         => 'show_ss',
1466     'section'     => 'UI',
1467     'description' => 'Turns on display/collection of social security numbers in the web interface.  Sometimes required by electronic check (ACH) processors.',
1468     'type'        => 'checkbox',
1469   },
1470
1471   {
1472     'key'         => 'show_stateid',
1473     'section'     => 'UI',
1474     'description' => "Turns on display/collection of driver's license/state issued id numbers in the web interface.  Sometimes required by electronic check (ACH) processors.",
1475     'type'        => 'checkbox',
1476   },
1477
1478   {
1479     'key'         => 'show_bankstate',
1480     'section'     => 'UI',
1481     'description' => "Turns on display/collection of state for bank accounts in the web interface.  Sometimes required by electronic check (ACH) processors.",
1482     'type'        => 'checkbox',
1483   },
1484
1485   {
1486     'key'         => 'agent_defaultpkg',
1487     'section'     => 'UI',
1488     'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
1489     'type'        => 'checkbox',
1490   },
1491
1492   {
1493     'key'         => 'legacy_link',
1494     'section'     => 'UI',
1495     'description' => 'Display options in the web interface to link legacy pre-Freeside services.',
1496     'type'        => 'checkbox',
1497   },
1498
1499   {
1500     'key'         => 'legacy_link-steal',
1501     'section'     => 'UI',
1502     'description' => 'Allow "stealing" an already-audited service from one customer (or package) to another using the link function.',
1503     'type'        => 'checkbox',
1504   },
1505
1506   {
1507     'key'         => 'queue_dangerous_controls',
1508     'section'     => 'UI',
1509     '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.',
1510     'type'        => 'checkbox',
1511   },
1512
1513   {
1514     'key'         => 'security_phrase',
1515     'section'     => 'password',
1516     'description' => 'Enable the tracking of a "security phrase" with each account.  Not recommended, as it is vulnerable to social engineering.',
1517     'type'        => 'checkbox',
1518   },
1519
1520   {
1521     'key'         => 'locale',
1522     'section'     => 'UI',
1523     'description' => 'Message locale',
1524     'type'        => 'select',
1525     'select_enum' => [ qw(en_US) ],
1526   },
1527
1528   {
1529     'key'         => 'signup_server-payby',
1530     'section'     => 'self-service',
1531     'description' => 'Acceptable payment types for the signup server',
1532     'type'        => 'selectmultiple',
1533     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB PREPAY BILL COMP) ],
1534   },
1535
1536   {
1537     'key'         => 'selfservice-save_unchecked',
1538     'section'     => 'self-service',
1539     'description' => 'In self-service, uncheck "Remember information" checkboxes by default (normally, they are checked by default).',
1540     'type'        => 'checkbox',
1541   },
1542
1543   {
1544     'key'         => 'signup_server-default_agentnum',
1545     'section'     => 'self-service',
1546     'description' => 'Default agent for the signup server',
1547     'type'        => 'select-sub',
1548     'options_sub' => sub { require FS::Record;
1549                            require FS::agent;
1550                            map { $_->agentnum => $_->agent }
1551                                FS::Record::qsearch('agent', { disabled=>'' } );
1552                          },
1553     'option_sub'  => sub { require FS::Record;
1554                            require FS::agent;
1555                            my $agent = FS::Record::qsearchs(
1556                              'agent', { 'agentnum'=>shift }
1557                            );
1558                            $agent ? $agent->agent : '';
1559                          },
1560   },
1561
1562   {
1563     'key'         => 'signup_server-default_refnum',
1564     'section'     => 'self-service',
1565     'description' => 'Default advertising source for the signup server',
1566     'type'        => 'select-sub',
1567     'options_sub' => sub { require FS::Record;
1568                            require FS::part_referral;
1569                            map { $_->refnum => $_->referral }
1570                                FS::Record::qsearch( 'part_referral',
1571                                                     { 'disabled' => '' }
1572                                                   );
1573                          },
1574     'option_sub'  => sub { require FS::Record;
1575                            require FS::part_referral;
1576                            my $part_referral = FS::Record::qsearchs(
1577                              'part_referral', { 'refnum'=>shift } );
1578                            $part_referral ? $part_referral->referral : '';
1579                          },
1580   },
1581
1582   {
1583     'key'         => 'signup_server-default_pkgpart',
1584     'section'     => 'self-service',
1585     'description' => 'Default package for the signup server',
1586     'type'        => 'select-part_pkg',
1587   },
1588
1589   {
1590     'key'         => 'signup_server-default_svcpart',
1591     'section'     => 'self-service',
1592     'description' => 'Default service definition for the signup server - only necessary for services that trigger special provisioning widgets (such as DID provisioning).',
1593     'type'        => 'select-part_svc',
1594   },
1595
1596   {
1597     'key'         => 'signup_server-mac_addr_svcparts',
1598     'section'     => 'self-service',
1599     'description' => 'Service definitions which can receive mac addresses (current mapped to username for svc_acct).',
1600     'type'        => 'select-part_svc',
1601     'multiple'    => 1,
1602   },
1603
1604   {
1605     'key'         => 'signup_server-nomadix',
1606     'section'     => 'self-service',
1607     'description' => 'Signup page Nomadix integration',
1608     'type'        => 'checkbox',
1609   },
1610
1611   {
1612     'key'         => 'signup_server-service',
1613     'section'     => 'self-service',
1614     'description' => 'Service for the signup server - "Account (svc_acct)" is the default setting, or "Phone number (svc_phone)" for ITSP signup',
1615     'type'        => 'select',
1616     'select_hash' => [
1617                        'svc_acct'  => 'Account (svc_acct)',
1618                        'svc_phone' => 'Phone number (svc_phone)',
1619                      ],
1620   },
1621
1622   {
1623     'key'         => 'selfservice_server-base_url',
1624     'section'     => 'self-service',
1625     '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.',
1626     'type'        => 'text',
1627   },
1628
1629   {
1630     'key'         => 'show-msgcat-codes',
1631     'section'     => 'UI',
1632     'description' => 'Show msgcat codes in error messages.  Turn this option on before reporting errors to the mailing list.',
1633     'type'        => 'checkbox',
1634   },
1635
1636   {
1637     'key'         => 'signup_server-realtime',
1638     'section'     => 'self-service',
1639     'description' => 'Run billing for signup server signups immediately, and do not provision accounts which subsequently have a balance.',
1640     'type'        => 'checkbox',
1641   },
1642   {
1643     'key'         => 'signup_server-classnum2',
1644     'section'     => 'self-service',
1645     'description' => 'Package Class for first optional purchase',
1646     'type'        => 'select-pkg_class',
1647   },
1648
1649   {
1650     'key'         => 'signup_server-classnum3',
1651     'section'     => 'self-service',
1652     'description' => 'Package Class for second optional purchase',
1653     'type'        => 'select-pkg_class',
1654   },
1655
1656   {
1657     'key'         => 'backend-realtime',
1658     'section'     => 'billing',
1659     'description' => 'Run billing for backend signups immediately.',
1660     'type'        => 'checkbox',
1661   },
1662
1663   {
1664     'key'         => 'declinetemplate',
1665     'section'     => 'billing',
1666     'description' => 'Template file for credit card and electronic check decline emails.',
1667     'type'        => 'textarea',
1668   },
1669
1670   {
1671     'key'         => 'emaildecline',
1672     'section'     => 'billing',
1673     'description' => 'Enable emailing of credit card and electronic check decline notices.',
1674     'type'        => 'checkbox',
1675   },
1676
1677   {
1678     'key'         => 'emaildecline-exclude',
1679     'section'     => 'billing',
1680     'description' => 'List of error messages that should not trigger email decline notices, one per line.',
1681     'type'        => 'textarea',
1682   },
1683
1684   {
1685     'key'         => 'cancelmessage',
1686     'section'     => 'billing',
1687     'description' => 'Template file for cancellation emails.',
1688     'type'        => 'textarea',
1689   },
1690
1691   {
1692     'key'         => 'cancelsubject',
1693     'section'     => 'billing',
1694     'description' => 'Subject line for cancellation emails.',
1695     'type'        => 'text',
1696   },
1697
1698   {
1699     'key'         => 'emailcancel',
1700     'section'     => 'billing',
1701     'description' => 'Enable emailing of cancellation notices.  Make sure to fill in the cancelmessage and cancelsubject configuration values as well.',
1702     'type'        => 'checkbox',
1703   },
1704
1705   {
1706     'key'         => 'bill_usage_on_cancel',
1707     'section'     => 'billing',
1708     '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.',
1709     'type'        => 'checkbox',
1710   },
1711
1712   {
1713     'key'         => 'require_cardname',
1714     'section'     => 'billing',
1715     'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
1716     'type'        => 'checkbox',
1717   },
1718
1719   {
1720     'key'         => 'enable_taxclasses',
1721     'section'     => 'billing',
1722     'description' => 'Enable per-package tax classes',
1723     'type'        => 'checkbox',
1724   },
1725
1726   {
1727     'key'         => 'require_taxclasses',
1728     'section'     => 'billing',
1729     'description' => 'Require a taxclass to be entered for every package',
1730     'type'        => 'checkbox',
1731   },
1732
1733   {
1734     'key'         => 'enable_taxproducts',
1735     'section'     => 'billing',
1736     'description' => 'Enable per-package mapping to vendor tax data from CCH or elsewhere.',
1737     'type'        => 'checkbox',
1738   },
1739
1740   {
1741     'key'         => 'taxdatadirectdownload',
1742     'section'     => 'billing',  #well
1743     'description' => 'Enable downloading tax data directly from the vendor site. at least three lines: URL, username, and password.j',
1744     'type'        => 'textarea',
1745   },
1746
1747   {
1748     'key'         => 'ignore_incalculable_taxes',
1749     'section'     => 'billing',
1750     'description' => 'Prefer to invoice without tax over not billing at all',
1751     'type'        => 'checkbox',
1752   },
1753
1754   {
1755     'key'         => 'welcome_email',
1756     'section'     => '',
1757     '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.  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></ul>',
1758     'type'        => 'textarea',
1759     'per_agent'   => 1,
1760   },
1761
1762   {
1763     'key'         => 'welcome_email-from',
1764     'section'     => '',
1765     'description' => 'From: address header for welcome email',
1766     'type'        => 'text',
1767     'per_agent'   => 1,
1768   },
1769
1770   {
1771     'key'         => 'welcome_email-subject',
1772     'section'     => '',
1773     'description' => 'Subject: header for welcome email',
1774     'type'        => 'text',
1775     'per_agent'   => 1,
1776   },
1777
1778   {
1779     'key'         => 'welcome_email-mimetype',
1780     'section'     => '',
1781     'description' => 'MIME type for welcome email',
1782     'type'        => 'select',
1783     'select_enum' => [ 'text/plain', 'text/html' ],
1784     'per_agent'   => 1,
1785   },
1786
1787   {
1788     'key'         => 'welcome_letter',
1789     'section'     => '',
1790     '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>',
1791     'type'        => 'textarea',
1792   },
1793
1794   {
1795     'key'         => 'warning_email',
1796     'section'     => '',
1797     '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>',
1798     'type'        => 'textarea',
1799   },
1800
1801   {
1802     'key'         => 'warning_email-from',
1803     'section'     => '',
1804     'description' => 'From: address header for warning email',
1805     'type'        => 'text',
1806   },
1807
1808   {
1809     'key'         => 'warning_email-cc',
1810     'section'     => '',
1811     'description' => 'Additional recipient(s) (comma separated) for warning email when remaining usage reaches zero.',
1812     'type'        => 'text',
1813   },
1814
1815   {
1816     'key'         => 'warning_email-subject',
1817     'section'     => '',
1818     'description' => 'Subject: header for warning email',
1819     'type'        => 'text',
1820   },
1821
1822   {
1823     'key'         => 'warning_email-mimetype',
1824     'section'     => '',
1825     'description' => 'MIME type for warning email',
1826     'type'        => 'select',
1827     'select_enum' => [ 'text/plain', 'text/html' ],
1828   },
1829
1830   {
1831     'key'         => 'payby',
1832     'section'     => 'billing',
1833     'description' => 'Available payment types.',
1834     'type'        => 'selectmultiple',
1835     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP) ],
1836   },
1837
1838   {
1839     'key'         => 'payby-default',
1840     'section'     => 'UI',
1841     'description' => 'Default payment type.  HIDE disables display of billing information and sets customers to BILL.',
1842     'type'        => 'select',
1843     'select_enum' => [ '', qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP HIDE) ],
1844   },
1845
1846   {
1847     'key'         => 'paymentforcedtobatch',
1848     'section'     => 'deprecated',
1849     '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.',
1850     'type'        => 'checkbox',
1851   },
1852
1853   {
1854     'key'         => 'svc_acct-notes',
1855     'section'     => 'deprecated',
1856     'description' => 'Extra HTML to be displayed on the Account View screen.',
1857     'type'        => 'textarea',
1858   },
1859
1860   {
1861     'key'         => 'radius-password',
1862     'section'     => '',
1863     'description' => 'RADIUS attribute for plain-text passwords.',
1864     'type'        => 'select',
1865     'select_enum' => [ 'Password', 'User-Password', 'Cleartext-Password' ],
1866   },
1867
1868   {
1869     'key'         => 'radius-ip',
1870     'section'     => '',
1871     'description' => 'RADIUS attribute for IP addresses.',
1872     'type'        => 'select',
1873     'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
1874   },
1875
1876   #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
1877   {
1878     'key'         => 'radius-chillispot-max',
1879     'section'     => '',
1880     'description' => 'Enable ChilliSpot (and CoovaChilli) Max attributes, specifically ChilliSpot-Max-{Input,Output,Total}-{Octets,Gigawords}.',
1881     'type'        => 'checkbox',
1882   },
1883
1884   {
1885     'key'         => 'svc_acct-alldomains',
1886     'section'     => '',
1887     '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.',
1888     'type'        => 'checkbox',
1889   },
1890
1891   {
1892     'key'         => 'dump-scpdest',
1893     'section'     => '',
1894     'description' => 'destination for scp database dumps: user@host:/path',
1895     'type'        => 'text',
1896   },
1897
1898   {
1899     'key'         => 'dump-pgpid',
1900     'section'     => '',
1901     '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.",
1902     'type'        => 'text',
1903   },
1904
1905   {
1906     'key'         => 'users-allow_comp',
1907     'section'     => 'deprecated',
1908     '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.',
1909     'type'        => 'textarea',
1910   },
1911
1912   {
1913     'key'         => 'credit_card-recurring_billing_flag',
1914     'section'     => 'billing',
1915     '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. ',
1916     'type'        => 'select',
1917     'select_hash' => [
1918                        'actual_oncard' => 'Default/classic behavior: set the flag if a customer has actual previous charges on the card.',
1919                        'transaction_is_recur' => 'Set the flag if the transaction itself is recurring, irregardless of previous charges on the card.',
1920                      ],
1921   },
1922
1923   {
1924     'key'         => 'credit_card-recurring_billing_acct_code',
1925     'section'     => 'billing',
1926     'description' => 'When the "recurring billing" flag is set, also set the "acct_code" to "rebill".  Useful for reporting purposes with supported gateways (PlugNPay, others?)',
1927     'type'        => 'checkbox',
1928   },
1929
1930   {
1931     'key'         => 'cvv-save',
1932     'section'     => 'billing',
1933     '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.',
1934     'type'        => 'selectmultiple',
1935     'select_enum' => \@card_types,
1936   },
1937
1938   {
1939     'key'         => 'manual_process-pkgpart',
1940     'section'     => 'billing',
1941     '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.',
1942     'type'        => 'select-part_pkg',
1943   },
1944
1945   {
1946     'key'         => 'manual_process-display',
1947     'section'     => 'billing',
1948     'description' => 'When using manual_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
1949     'type'        => 'select',
1950     'select_hash' => [
1951                        'add'      => 'Add fee to amount entered',
1952                        'subtract' => 'Subtract fee from amount entered',
1953                      ],
1954   },
1955
1956   {
1957     'key'         => 'manual_process-skip_first',
1958     'section'     => 'billing',
1959     'description' => "When using manual_process-pkgpart, omit the fee if it is the customer's first payment.",
1960     'type'        => 'checkbox',
1961   },
1962
1963   {
1964     'key'         => 'allow_negative_charges',
1965     'section'     => 'billing',
1966     'description' => 'Allow negative charges.  Normally not used unless importing data from a legacy system that requires this.',
1967     'type'        => 'checkbox',
1968   },
1969   {
1970       'key'         => 'auto_unset_catchall',
1971       'section'     => '',
1972       '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.',
1973       'type'        => 'checkbox',
1974   },
1975
1976   {
1977     'key'         => 'system_usernames',
1978     'section'     => 'username',
1979     '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.',
1980     'type'        => 'textarea',
1981   },
1982
1983   {
1984     'key'         => 'cust_pkg-change_svcpart',
1985     'section'     => '',
1986     'description' => "When changing packages, move services even if svcparts don't match between old and new pacakge definitions.",
1987     'type'        => 'checkbox',
1988   },
1989
1990   {
1991     'key'         => 'cust_pkg-change_pkgpart-bill_now',
1992     'section'     => '',
1993     '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.",
1994     'type'        => 'checkbox',
1995   },
1996
1997   {
1998     'key'         => 'disable_autoreverse',
1999     'section'     => 'BIND',
2000     'description' => 'Disable automatic synchronization of reverse-ARPA entries.',
2001     'type'        => 'checkbox',
2002   },
2003
2004   {
2005     'key'         => 'svc_www-enable_subdomains',
2006     'section'     => '',
2007     'description' => 'Enable selection of specific subdomains for virtual host creation.',
2008     'type'        => 'checkbox',
2009   },
2010
2011   {
2012     'key'         => 'svc_www-usersvc_svcpart',
2013     'section'     => '',
2014     'description' => 'Allowable service definition svcparts for virtual hosts, one per line.',
2015     'type'        => 'select-part_svc',
2016     'multiple'    => 1,
2017   },
2018
2019   {
2020     'key'         => 'selfservice_server-primary_only',
2021     'section'     => 'self-service',
2022     'description' => 'Only allow primary accounts to access self-service functionality.',
2023     'type'        => 'checkbox',
2024   },
2025
2026   {
2027     'key'         => 'selfservice_server-phone_login',
2028     'section'     => 'self-service',
2029     'description' => 'Allow login to self-service with phone number and PIN.',
2030     'type'        => 'checkbox',
2031   },
2032
2033   {
2034     'key'         => 'selfservice_server-single_domain',
2035     'section'     => 'self-service',
2036     'description' => 'If specified, only use this one domain for self-service access.',
2037     'type'        => 'text',
2038   },
2039
2040   {
2041     'key'         => 'card_refund-days',
2042     'section'     => 'billing',
2043     'description' => 'After a payment, the number of days a refund link will be available for that payment.  Defaults to 120.',
2044     'type'        => 'text',
2045   },
2046
2047   {
2048     'key'         => 'agent-showpasswords',
2049     'section'     => '',
2050     'description' => 'Display unencrypted user passwords in the agent (reseller) interface',
2051     'type'        => 'checkbox',
2052   },
2053
2054   {
2055     'key'         => 'global_unique-username',
2056     'section'     => 'username',
2057     '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.',
2058     'type'        => 'select',
2059     'select_enum' => [ 'none', 'username', 'username@domain', 'disabled' ],
2060   },
2061
2062   {
2063     'key'         => 'global_unique-phonenum',
2064     'section'     => '',
2065     '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.',
2066     'type'        => 'select',
2067     'select_enum' => [ 'none', 'countrycode+phonenum', 'disabled' ],
2068   },
2069
2070   {
2071     'key'         => 'svc_external-skip_manual',
2072     'section'     => 'UI',
2073     '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).',
2074     'type'        => 'checkbox',
2075   },
2076
2077   {
2078     'key'         => 'svc_external-display_type',
2079     'section'     => 'UI',
2080     'description' => 'Select a specific svc_external type to enable some UI changes specific to that type (i.e. artera_turbo).',
2081     'type'        => 'select',
2082     'select_enum' => [ 'generic', 'artera_turbo', ],
2083   },
2084
2085   {
2086     'key'         => 'ticket_system',
2087     'section'     => '',
2088     '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:1.7:Documentation:RT_Installation">integrated ticketing installation instructions</a>).   <b>RT_External</b> accesses an external RT installation in a separate database (local or remote).',
2089     'type'        => 'select',
2090     #'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
2091     'select_enum' => [ '', qw(RT_Internal RT_External) ],
2092   },
2093
2094   {
2095     'key'         => 'ticket_system-default_queueid',
2096     'section'     => '',
2097     'description' => 'Default queue used when creating new customer tickets.',
2098     'type'        => 'select-sub',
2099     'options_sub' => sub {
2100                            my $conf = new FS::Conf;
2101                            if ( $conf->config('ticket_system') ) {
2102                              eval "use FS::TicketSystem;";
2103                              die $@ if $@;
2104                              FS::TicketSystem->queues();
2105                            } else {
2106                              ();
2107                            }
2108                          },
2109     'option_sub'  => sub {
2110                            my $conf = new FS::Conf;
2111                            if ( $conf->config('ticket_system') ) {
2112                              eval "use FS::TicketSystem;";
2113                              die $@ if $@;
2114                              FS::TicketSystem->queue(shift);
2115                            } else {
2116                              '';
2117                            }
2118                          },
2119   },
2120
2121   {
2122     'key'         => 'ticket_system-selfservice_queueid',
2123     'section'     => '',
2124     'description' => 'Queue used when creating new customer tickets from self-service.  Defautls to ticket_system-default_queueid if not specified.',
2125     #false laziness w/above
2126     'type'        => 'select-sub',
2127     'options_sub' => sub {
2128                            my $conf = new FS::Conf;
2129                            if ( $conf->config('ticket_system') ) {
2130                              eval "use FS::TicketSystem;";
2131                              die $@ if $@;
2132                              FS::TicketSystem->queues();
2133                            } else {
2134                              ();
2135                            }
2136                          },
2137     'option_sub'  => sub {
2138                            my $conf = new FS::Conf;
2139                            if ( $conf->config('ticket_system') ) {
2140                              eval "use FS::TicketSystem;";
2141                              die $@ if $@;
2142                              FS::TicketSystem->queue(shift);
2143                            } else {
2144                              '';
2145                            }
2146                          },
2147   },
2148
2149   {
2150     'key'         => 'ticket_system-priority_reverse',
2151     'section'     => '',
2152     '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.',
2153     'type'        => 'checkbox',
2154   },
2155
2156   {
2157     'key'         => 'ticket_system-custom_priority_field',
2158     'section'     => '',
2159     'description' => 'Custom field from the ticketing system to use as a custom priority classification.',
2160     'type'        => 'text',
2161   },
2162
2163   {
2164     'key'         => 'ticket_system-custom_priority_field-values',
2165     'section'     => '',
2166     'description' => 'Values for the custom field from the ticketing system to break down and sort customer ticket lists.',
2167     'type'        => 'textarea',
2168   },
2169
2170   {
2171     'key'         => 'ticket_system-custom_priority_field_queue',
2172     'section'     => '',
2173     'description' => 'Ticketing system queue in which the custom field specified in ticket_system-custom_priority_field is located.',
2174     'type'        => 'text',
2175   },
2176
2177   {
2178     'key'         => 'ticket_system-rt_external_datasrc',
2179     'section'     => '',
2180     '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>',
2181     'type'        => 'text',
2182
2183   },
2184
2185   {
2186     'key'         => 'ticket_system-rt_external_url',
2187     'section'     => '',
2188     'description' => 'With external RT integration, the URL for the external RT installation, for example, <code>https://rt.example.com/rt</code>',
2189     'type'        => 'text',
2190   },
2191
2192   {
2193     'key'         => 'company_name',
2194     'section'     => 'required',
2195     'description' => 'Your company name',
2196     'type'        => 'text',
2197     'per_agent'   => 1, #XXX just FS/FS/ClientAPI/Signup.pm
2198   },
2199
2200   {
2201     'key'         => 'company_address',
2202     'section'     => 'required',
2203     'description' => 'Your company address',
2204     'type'        => 'textarea',
2205     'per_agent'   => 1,
2206   },
2207
2208   {
2209     'key'         => 'echeck-void',
2210     'section'     => 'deprecated',
2211     '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',
2212     'type'        => 'checkbox',
2213   },
2214
2215   {
2216     'key'         => 'cc-void',
2217     'section'     => 'deprecated',
2218     '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',
2219     'type'        => 'checkbox',
2220   },
2221
2222   {
2223     'key'         => 'unvoid',
2224     'section'     => 'deprecated',
2225     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable unvoiding of voided payments',
2226     'type'        => 'checkbox',
2227   },
2228
2229   {
2230     'key'         => 'address1-search',
2231     'section'     => 'UI',
2232     'description' => 'Enable the ability to search the address1 field from customer search.',
2233     'type'        => 'checkbox',
2234   },
2235
2236   {
2237     'key'         => 'address2-search',
2238     'section'     => 'UI',
2239     'description' => 'Enable a "Unit" search box which searches the second address field.  Useful for multi-tenant applications.  See also: cust_main-require_address2',
2240     'type'        => 'checkbox',
2241   },
2242
2243   {
2244     'key'         => 'cust_main-require_address2',
2245     'section'     => 'UI',
2246     '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',
2247     'type'        => 'checkbox',
2248   },
2249
2250   {
2251     'key'         => 'agent-ship_address',
2252     'section'     => '',
2253     '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.",
2254     'type'        => 'checkbox',
2255   },
2256
2257   { 'key'         => 'referral_credit',
2258     'section'     => 'deprecated',
2259     '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.",
2260     'type'        => 'checkbox',
2261   },
2262
2263   { 'key'         => 'selfservice_server-cache_module',
2264     'section'     => 'self-service',
2265     '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.',
2266     'type'        => 'select',
2267     'select_enum' => [ 'Cache::SharedMemoryCache', 'Cache::FileCache', ], # '_Database' ],
2268   },
2269
2270   {
2271     'key'         => 'hylafax',
2272     'section'     => 'billing',
2273     '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).',
2274     'type'        => [qw( checkbox textarea )],
2275   },
2276
2277   {
2278     'key'         => 'cust_bill-ftpformat',
2279     'section'     => 'invoicing',
2280     'description' => 'Enable FTP of raw invoice data - format.',
2281     'type'        => 'select',
2282     'select_enum' => [ '', 'default', 'billco', ],
2283   },
2284
2285   {
2286     'key'         => 'cust_bill-ftpserver',
2287     'section'     => 'invoicing',
2288     'description' => 'Enable FTP of raw invoice data - server.',
2289     'type'        => 'text',
2290   },
2291
2292   {
2293     'key'         => 'cust_bill-ftpusername',
2294     'section'     => 'invoicing',
2295     'description' => 'Enable FTP of raw invoice data - server.',
2296     'type'        => 'text',
2297   },
2298
2299   {
2300     'key'         => 'cust_bill-ftppassword',
2301     'section'     => 'invoicing',
2302     'description' => 'Enable FTP of raw invoice data - server.',
2303     'type'        => 'text',
2304   },
2305
2306   {
2307     'key'         => 'cust_bill-ftpdir',
2308     'section'     => 'invoicing',
2309     'description' => 'Enable FTP of raw invoice data - server.',
2310     'type'        => 'text',
2311   },
2312
2313   {
2314     'key'         => 'cust_bill-spoolformat',
2315     'section'     => 'invoicing',
2316     'description' => 'Enable spooling of raw invoice data - format.',
2317     'type'        => 'select',
2318     'select_enum' => [ '', 'default', 'billco', ],
2319   },
2320
2321   {
2322     'key'         => 'cust_bill-spoolagent',
2323     'section'     => 'invoicing',
2324     'description' => 'Enable per-agent spooling of raw invoice data.',
2325     'type'        => 'checkbox',
2326   },
2327
2328   {
2329     'key'         => 'svc_acct-usage_suspend',
2330     'section'     => 'billing',
2331     '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.',
2332     'type'        => 'checkbox',
2333   },
2334
2335   {
2336     'key'         => 'svc_acct-usage_unsuspend',
2337     'section'     => 'billing',
2338     '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.',
2339     'type'        => 'checkbox',
2340   },
2341
2342   {
2343     'key'         => 'svc_acct-usage_threshold',
2344     'section'     => 'billing',
2345     '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.',
2346     'type'        => 'text',
2347   },
2348
2349   {
2350     'key'         => 'overlimit_groups',
2351     'section'     => '',
2352     'description' => 'RADIUS group (or comma-separated groups) to assign to svc_acct which has exceeded its bandwidth or time limit.',
2353     'type'        => 'text',
2354     'per_agent'   => 1,
2355   },
2356
2357   {
2358     'key'         => 'cust-fields',
2359     'section'     => 'UI',
2360     'description' => 'Which customer fields to display on reports by default',
2361     'type'        => 'select',
2362     'select_hash' => [ FS::ConfDefaults->cust_fields_avail() ],
2363   },
2364
2365   {
2366     'key'         => 'cust_pkg-display_times',
2367     'section'     => 'UI',
2368     'description' => 'Display full timestamps (not just dates) for customer packages.  Useful if you are doing real-time things like hourly prepaid.',
2369     'type'        => 'checkbox',
2370   },
2371
2372   {
2373     'key'         => 'cust_pkg-always_show_location',
2374     'section'     => 'UI',
2375     'description' => "Always display package locations, even when they're all the default service address.",
2376     'type'        => 'checkbox',
2377   },
2378
2379   {
2380     'key'         => 'cust_pkg-show_fcc_voice_grade_equivalent',
2381     'section'     => 'UI',
2382     'description' => "Show a field on package definitions for assigning a DSO equivalency number suitable for use on FCC form 477.",
2383     'type'        => 'checkbox',
2384   },
2385
2386   {
2387     'key'         => 'svc_acct-edit_uid',
2388     'section'     => 'shell',
2389     'description' => 'Allow UID editing.',
2390     'type'        => 'checkbox',
2391   },
2392
2393   {
2394     'key'         => 'svc_acct-edit_gid',
2395     'section'     => 'shell',
2396     'description' => 'Allow GID editing.',
2397     'type'        => 'checkbox',
2398   },
2399
2400   {
2401     'key'         => 'zone-underscore',
2402     'section'     => 'BIND',
2403     'description' => 'Allow underscores in zone names.  As underscores are illegal characters in zone names, this option is not recommended.',
2404     'type'        => 'checkbox',
2405   },
2406
2407   {
2408     'key'         => 'echeck-nonus',
2409     'section'     => 'billing',
2410     'description' => 'Disable ABA-format account checking for Electronic Check payment info',
2411     'type'        => 'checkbox',
2412   },
2413
2414   {
2415     'key'         => 'voip-cust_cdr_spools',
2416     'section'     => '',
2417     'description' => 'Enable the per-customer option for individual CDR spools.',
2418     'type'        => 'checkbox',
2419   },
2420
2421   {
2422     'key'         => 'voip-cust_cdr_squelch',
2423     'section'     => '',
2424     'description' => 'Enable the per-customer option for not printing CDR on invoices.',
2425     'type'        => 'checkbox',
2426   },
2427
2428   {
2429     'key'         => 'voip-cdr_email',
2430     'section'     => '',
2431     'description' => 'Include the call details on emailed invoices even if the customer is configured for not printing them on the invoices.',
2432     'type'        => 'checkbox',
2433   },
2434
2435   {
2436     'key'         => 'voip-cust_email_csv_cdr',
2437     'section'     => '',
2438     'description' => 'Enable the per-customer option for including CDR information as a CSV attachment on emailed invoices.',
2439     'type'        => 'checkbox',
2440   },
2441
2442   {
2443     'key'         => 'svc_forward-no_srcsvc',
2444     'section'     => '',
2445     '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.",
2446     'type'        => 'checkbox',
2447   },
2448
2449   {
2450     'key'         => 'svc_forward-arbitrary_dst',
2451     'section'     => '',
2452     '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.",
2453     'type'        => 'checkbox',
2454   },
2455
2456   {
2457     'key'         => 'tax-ship_address',
2458     'section'     => 'billing',
2459     'description' => 'By default, tax calculations are done based on the billing address.  Enable this switch to calculate tax based on the shipping address instead.',
2460     'type'        => 'checkbox',
2461   }
2462 ,
2463   {
2464     'key'         => 'tax-pkg_address',
2465     'section'     => 'billing',
2466     '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).  Note that this option is currently incompatible with vendor data taxation enabled by enable_taxproducts.',
2467     'type'        => 'checkbox',
2468   },
2469
2470   {
2471     'key'         => 'invoice-ship_address',
2472     'section'     => 'invoicing',
2473     'description' => 'Include the shipping address on invoices.',
2474     'type'        => 'checkbox',
2475   },
2476
2477   {
2478     'key'         => 'invoice-unitprice',
2479     'section'     => 'invoicing',
2480     'description' => 'Enable unit pricing on invoices.',
2481     'type'        => 'checkbox',
2482   },
2483
2484   {
2485     'key'         => 'invoice-smallernotes',
2486     'section'     => 'invoicing',
2487     'description' => 'Display the notes section in a smaller font on invoices.',
2488     'type'        => 'checkbox',
2489   },
2490
2491   {
2492     'key'         => 'invoice-smallerfooter',
2493     'section'     => 'invoicing',
2494     'description' => 'Display footers in a smaller font on invoices.',
2495     'type'        => 'checkbox',
2496   },
2497
2498   {
2499     'key'         => 'postal_invoice-fee_pkgpart',
2500     'section'     => 'billing',
2501     'description' => 'This allows selection of a package to insert on invoices for customers with postal invoices selected.',
2502     'type'        => 'select-part_pkg',
2503   },
2504
2505   {
2506     'key'         => 'postal_invoice-recurring_only',
2507     'section'     => 'billing',
2508     'description' => 'The postal invoice fee is omitted on invoices without reucrring charges when this is set.',
2509     'type'        => 'checkbox',
2510   },
2511
2512   {
2513     'key'         => 'batch-enable',
2514     'section'     => 'deprecated', #make sure batch-enable_payby is set for
2515                                    #everyone before removing
2516     'description' => 'Enable credit card and/or ACH batching - leave disabled for real-time installations.',
2517     'type'        => 'checkbox',
2518   },
2519
2520   {
2521     'key'         => 'batch-enable_payby',
2522     'section'     => 'billing',
2523     'description' => 'Enable batch processing for the specified payment types.',
2524     'type'        => 'selectmultiple',
2525     'select_enum' => [qw( CARD CHEK )],
2526   },
2527
2528   {
2529     'key'         => 'realtime-disable_payby',
2530     'section'     => 'billing',
2531     'description' => 'Disable realtime processing for the specified payment types.',
2532     'type'        => 'selectmultiple',
2533     'select_enum' => [qw( CARD CHEK )],
2534   },
2535
2536   {
2537     'key'         => 'batch-default_format',
2538     'section'     => 'billing',
2539     'description' => 'Default format for batches.',
2540     'type'        => 'select',
2541     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch',
2542                        'csv-chase_canada-E-xactBatch', 'BoM', 'PAP',
2543                        'paymentech', 'ach-spiritone', 'RBC'
2544                     ]
2545   },
2546
2547   #lists could be auto-generated from pay_batch info
2548   {
2549     'key'         => 'batch-fixed_format-CARD',
2550     'section'     => 'billing',
2551     'description' => 'Fixed (unchangeable) format for credit card batches.',
2552     'type'        => 'select',
2553     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP' ,
2554                        'csv-chase_canada-E-xactBatch', 'paymentech' ]
2555   },
2556
2557   {
2558     'key'         => 'batch-fixed_format-CHEK',
2559     'section'     => 'billing',
2560     'description' => 'Fixed (unchangeable) format for electronic check batches.',
2561     'type'        => 'select',
2562     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP',
2563                        'paymentech', 'ach-spiritone', 'RBC'
2564                      ]
2565   },
2566
2567   {
2568     'key'         => 'batch-increment_expiration',
2569     'section'     => 'billing',
2570     'description' => 'Increment expiration date years in batches until cards are current.  Make sure this is acceptable to your batching provider before enabling.',
2571     'type'        => 'checkbox'
2572   },
2573
2574   {
2575     'key'         => 'batchconfig-BoM',
2576     'section'     => 'billing',
2577     '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',
2578     'type'        => 'textarea',
2579   },
2580
2581   {
2582     'key'         => 'batchconfig-PAP',
2583     'section'     => 'billing',
2584     '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',
2585     'type'        => 'textarea',
2586   },
2587
2588   {
2589     'key'         => 'batchconfig-csv-chase_canada-E-xactBatch',
2590     'section'     => 'billing',
2591     'description' => 'Gateway ID for Chase Canada E-xact batching',
2592     'type'        => 'text',
2593   },
2594
2595   {
2596     'key'         => 'batchconfig-paymentech',
2597     'section'     => 'billing',
2598     'description' => 'Configuration for Chase Paymentech batching, five lines: 1. BIN, 2. Terminal ID, 3. Merchant ID, 4. Username, 5. Password (for batch uploads)',
2599     'type'        => 'textarea',
2600   },
2601
2602   {
2603     'key'         => 'batchconfig-RBC',
2604     'section'     => 'billing',
2605     'description' => 'Configuration for Royal Bank of Canada PDS batching, four lines: 1. Client number, 2. Short name, 3. Long name, 4. Transaction code.',
2606     'type'        => 'textarea',
2607   },
2608
2609   {
2610     'key'         => 'payment_history-years',
2611     'section'     => 'UI',
2612     'description' => 'Number of years of payment history to show by default.  Currently defaults to 2.',
2613     'type'        => 'text',
2614   },
2615
2616   {
2617     'key'         => 'change_history-years',
2618     'section'     => 'UI',
2619     'description' => 'Number of years of change history to show by default.  Currently defaults to 0.5.',
2620     'type'        => 'text',
2621   },
2622
2623   {
2624     'key'         => 'cust_main-packages-years',
2625     'section'     => 'UI',
2626     'description' => 'Number of years to show old (cancelled and one-time charge) packages by default.  Currently defaults to 2.',
2627     'type'        => 'text',
2628   },
2629
2630   {
2631     'key'         => 'cust_main-use_comments',
2632     'section'     => 'UI',
2633     'description' => 'Display free form comments on the customer edit screen.  Useful as a scratch pad.',
2634     'type'        => 'checkbox',
2635   },
2636
2637   {
2638     'key'         => 'cust_main-disable_notes',
2639     'section'     => 'UI',
2640     'description' => 'Disable new style customer notes - timestamped and user identified customer notes.  Useful in tracking who did what.',
2641     'type'        => 'checkbox',
2642   },
2643
2644   {
2645     'key'         => 'cust_main_note-display_times',
2646     'section'     => 'UI',
2647     'description' => 'Display full timestamps (not just dates) for customer notes.',
2648     'type'        => 'checkbox',
2649   },
2650
2651   {
2652     'key'         => 'cust_main-ticket_statuses',
2653     'section'     => 'UI',
2654     'description' => 'Show tickets with these statuses on the customer view page.',
2655     'type'        => 'selectmultiple',
2656     'select_enum' => [qw( new open stalled resolved rejected deleted )],
2657   },
2658
2659   {
2660     'key'         => 'cust_main-max_tickets',
2661     'section'     => 'UI',
2662     'description' => 'Maximum number of tickets to show on the customer view page.',
2663     'type'        => 'text',
2664   },
2665
2666   {
2667     'key'         => 'cust_main-skeleton_tables',
2668     'section'     => '',
2669     '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.',
2670     'type'        => 'textarea',
2671   },
2672
2673   {
2674     'key'         => 'cust_main-skeleton_custnum',
2675     'section'     => '',
2676     'description' => 'Customer number specifying the source data to copy into skeleton tables for new customers.',
2677     'type'        => 'text',
2678   },
2679
2680   {
2681     'key'         => 'cust_main-enable_birthdate',
2682     'section'     => 'UI',
2683     'descritpion' => 'Enable tracking of a birth date with each customer record',
2684     'type'        => 'checkbox',
2685   },
2686
2687   {
2688     'key'         => 'support-key',
2689     'section'     => '',
2690     '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.',
2691     'type'        => 'text',
2692   },
2693
2694   {
2695     'key'         => 'card-types',
2696     'section'     => 'billing',
2697     'description' => 'Select one or more card types to enable only those card types.  If no card types are selected, all card types are available.',
2698     'type'        => 'selectmultiple',
2699     'select_enum' => \@card_types,
2700   },
2701
2702   {
2703     'key'         => 'disable-fuzzy',
2704     'section'     => 'UI',
2705     'description' => 'Disable fuzzy searching.  Speeds up searching for large sites, but only shows exact matches.',
2706     'type'        => 'checkbox',
2707   },
2708
2709   { 'key'         => 'pkg_referral',
2710     'section'     => '',
2711     'description' => 'Enable package-specific advertising sources.',
2712     'type'        => 'checkbox',
2713   },
2714
2715   { 'key'         => 'pkg_referral-multiple',
2716     'section'     => '',
2717     'description' => 'In addition, allow multiple advertising sources to be associated with a single package.',
2718     'type'        => 'checkbox',
2719   },
2720
2721   {
2722     'key'         => 'dashboard-install_welcome',
2723     'section'     => 'UI',
2724     'description' => 'New install welcome screen.',
2725     'type'        => 'select',
2726     'select_enum' => [ '', 'ITSP_fsinc_hosted', ],
2727   },
2728
2729   {
2730     'key'         => 'dashboard-toplist',
2731     'section'     => 'UI',
2732     'description' => 'List of items to display on the top of the front page',
2733     'type'        => 'textarea',
2734   },
2735
2736   {
2737     'key'         => 'impending_recur_template',
2738     'section'     => 'billing',
2739     '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>',
2740 # <li><code>$payby</code> <li><code>$expdate</code> most likely only confuse
2741     'type'        => 'textarea',
2742   },
2743
2744   {
2745     'key'         => 'logo.png',
2746     'section'     => 'UI',  #'invoicing' ?
2747     'description' => 'Company logo for HTML invoices and the backoffice interface, in PNG format.  Suggested size somewhere near 92x62.',
2748     'type'        => 'image',
2749     'per_agent'   => 1, #XXX just view/logo.cgi, which is for the global
2750                         #old-style editor anyway...?
2751   },
2752
2753   {
2754     'key'         => 'logo.eps',
2755     'section'     => 'invoicing',
2756     'description' => 'Company logo for printed and PDF invoices, in EPS format.',
2757     'type'        => 'image',
2758     'per_agent'   => 1, #XXX as above, kinda
2759   },
2760
2761   {
2762     'key'         => 'selfservice-ignore_quantity',
2763     'section'     => 'self-service',
2764     'description' => 'Ignores service quantity restrictions in self-service context.  Strongly not recommended - just set your quantities correctly in the first place.',
2765     'type'        => 'checkbox',
2766   },
2767
2768   {
2769     'key'         => 'selfservice-session_timeout',
2770     'section'     => 'self-service',
2771     'description' => 'Self-service session timeout.  Defaults to 1 hour.',
2772     'type'        => 'select',
2773     'select_enum' => [ '1 hour', '2 hours', '4 hours', '8 hours', '1 day', '1 week', ],
2774   },
2775
2776   {
2777     'key'         => 'disable_setup_suspended_pkgs',
2778     'section'     => 'billing',
2779     'description' => 'Disables charging of setup fees for suspended packages.',
2780     'type'        => 'checkbox',
2781   },
2782
2783   {
2784     'key'         => 'password-generated-allcaps',
2785     'section'     => 'password',
2786     'description' => 'Causes passwords automatically generated to consist entirely of capital letters',
2787     'type'        => 'checkbox',
2788   },
2789
2790   {
2791     'key'         => 'datavolume-forcemegabytes',
2792     'section'     => 'UI',
2793     'description' => 'All data volumes are expressed in megabytes',
2794     'type'        => 'checkbox',
2795   },
2796
2797   {
2798     'key'         => 'datavolume-significantdigits',
2799     'section'     => 'UI',
2800     'description' => 'number of significant digits to use to represent data volumes',
2801     'type'        => 'text',
2802   },
2803
2804   {
2805     'key'         => 'disable_void_after',
2806     'section'     => 'billing',
2807     'description' => 'Number of seconds after which freeside won\'t attempt to VOID a payment first when performing a refund.',
2808     'type'        => 'text',
2809   },
2810
2811   {
2812     'key'         => 'disable_line_item_date_ranges',
2813     'section'     => 'billing',
2814     'description' => 'Prevent freeside from automatically generating date ranges on invoice line items.',
2815     'type'        => 'checkbox',
2816   },
2817
2818   {
2819     'key'         => 'support_packages',
2820     'section'     => '',
2821     '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...
2822     'type'        => 'select-part_pkg',
2823     'multiple'    => 1,
2824   },
2825
2826   {
2827     'key'         => 'cust_main-require_phone',
2828     'section'     => '',
2829     'description' => 'Require daytime or night phone for all customer records.',
2830     'type'        => 'checkbox',
2831   },
2832
2833   {
2834     'key'         => 'cust_main-require_invoicing_list_email',
2835     'section'     => '',
2836     'description' => 'Email address field is required: require at least one invoicing email address for all customer records.',
2837     'type'        => 'checkbox',
2838   },
2839
2840   {
2841     'key'         => 'svc_acct-display_paid_time_remaining',
2842     'section'     => '',
2843     'description' => 'Show paid time remaining in addition to time remaining.',
2844     'type'        => 'checkbox',
2845   },
2846
2847   {
2848     'key'         => 'cancel_credit_type',
2849     'section'     => 'billing',
2850     'description' => 'The group to use for new, automatically generated credit reasons resulting from cancellation.',
2851     'type'        => 'select-sub',
2852     'options_sub' => sub { require FS::Record;
2853                            require FS::reason_type;
2854                            map { $_->typenum => $_->type }
2855                                FS::Record::qsearch('reason_type', { class=>'R' } );
2856                          },
2857     'option_sub'  => sub { require FS::Record;
2858                            require FS::reason_type;
2859                            my $reason_type = FS::Record::qsearchs(
2860                              'reason_type', { 'typenum' => shift }
2861                            );
2862                            $reason_type ? $reason_type->type : '';
2863                          },
2864   },
2865
2866   {
2867     'key'         => 'referral_credit_type',
2868     'section'     => 'deprecated',
2869     '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.',
2870     'type'        => 'select-sub',
2871     'options_sub' => sub { require FS::Record;
2872                            require FS::reason_type;
2873                            map { $_->typenum => $_->type }
2874                                FS::Record::qsearch('reason_type', { class=>'R' } );
2875                          },
2876     'option_sub'  => sub { require FS::Record;
2877                            require FS::reason_type;
2878                            my $reason_type = FS::Record::qsearchs(
2879                              'reason_type', { 'typenum' => shift }
2880                            );
2881                            $reason_type ? $reason_type->type : '';
2882                          },
2883   },
2884
2885   {
2886     'key'         => 'signup_credit_type',
2887     'section'     => 'billing', #self-service?
2888     'description' => 'The group to use for new, automatically generated credit reasons resulting from signup and self-service declines.',
2889     'type'        => 'select-sub',
2890     'options_sub' => sub { require FS::Record;
2891                            require FS::reason_type;
2892                            map { $_->typenum => $_->type }
2893                                FS::Record::qsearch('reason_type', { class=>'R' } );
2894                          },
2895     'option_sub'  => sub { require FS::Record;
2896                            require FS::reason_type;
2897                            my $reason_type = FS::Record::qsearchs(
2898                              'reason_type', { 'typenum' => shift }
2899                            );
2900                            $reason_type ? $reason_type->type : '';
2901                          },
2902   },
2903
2904   {
2905     'key'         => 'cust_main-agent_custid-format',
2906     'section'     => '',
2907     'description' => 'Enables searching of various formatted values in cust_main.agent_custid',
2908     'type'        => 'select',
2909     'select_hash' => [
2910                        ''      => 'Numeric only',
2911                        'ww?d+' => 'Numeric with one or two letter prefix',
2912                      ],
2913   },
2914
2915   {
2916     'key'         => 'card_masking_method',
2917     'section'     => 'UI',
2918     '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.',
2919     'type'        => 'select',
2920     'select_hash' => [
2921                        ''            => '123456xxxxxx1234',
2922                        'first6last2' => '123456xxxxxxxx12',
2923                        'first4last4' => '1234xxxxxxxx1234',
2924                        'first4last2' => '1234xxxxxxxxxx12',
2925                        'first2last4' => '12xxxxxxxxxx1234',
2926                        'first2last2' => '12xxxxxxxxxxxx12',
2927                        'first0last4' => 'xxxxxxxxxxxx1234',
2928                        'first0last2' => 'xxxxxxxxxxxxxx12',
2929                      ],
2930   },
2931
2932   {
2933     'key'         => 'disable_previous_balance',
2934     'section'     => 'invoicing',
2935     'description' => 'Disable inclusion of previous balance, payment, and credit lines on invoices',
2936     'type'        => 'checkbox',
2937   },
2938
2939   {
2940     'key'         => 'previous_balance-exclude_from_total',
2941     'section'     => 'invoicing',
2942     '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',
2943     'type'        => [ qw(checkbox text) ],
2944   },
2945
2946   {
2947     'key'         => 'previous_balance-summary_only',
2948     'section'     => 'invoicing',
2949     'description' => 'Only show a single line summarizing the total previous balance rather than one line per invoice.',
2950     'type'        => 'checkbox',
2951   },
2952
2953   {
2954     'key'         => 'balance_due_below_line',
2955     'section'     => 'invoicing',
2956     'description' => 'Place the balance due message below a line.  Only meaningful when when invoice_sections is false.',
2957     'type'        => 'checkbox',
2958   },
2959
2960   {
2961     'key'         => 'usps_webtools-userid',
2962     'section'     => 'UI',
2963     '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.',
2964     'type'        => 'text',
2965   },
2966
2967   {
2968     'key'         => 'usps_webtools-password',
2969     'section'     => 'UI',
2970     '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.',
2971     'type'        => 'text',
2972   },
2973
2974   {
2975     'key'         => 'cust_main-auto_standardize_address',
2976     'section'     => 'UI',
2977     'description' => 'When using USPS web tools, automatically standardize the address without asking.',
2978     'type'        => 'checkbox',
2979   },
2980
2981   {
2982     'key'         => 'cust_main-require_censustract',
2983     'section'     => 'UI',
2984     'description' => 'Customer is required to have a census tract.  Useful for FCC form 477 reports. See also: cust_main-auto_standardize_address',
2985     'type'        => 'checkbox',
2986   },
2987
2988   {
2989     'key'         => 'census_year',
2990     'section'     => 'UI',
2991     'description' => 'The year to use in census tract lookups',
2992     'type'        => 'select',
2993     'select_enum' => [ qw( 2009 2008 2007 2006 ) ],
2994   },
2995
2996   {
2997     'key'         => 'company_latitude',
2998     'section'     => 'UI',
2999     'description' => 'Your company latitude (-90 through 90)',
3000     'type'        => 'text',
3001   },
3002
3003   {
3004     'key'         => 'company_longitude',
3005     'section'     => 'UI',
3006     'description' => 'Your company longitude (-180 thru 180)',
3007     'type'        => 'text',
3008   },
3009
3010   {
3011     'key'         => 'disable_acl_changes',
3012     'section'     => '',
3013     'description' => 'Disable all ACL changes, for demos.',
3014     'type'        => 'checkbox',
3015   },
3016
3017   {
3018     'key'         => 'disable_settings_changes',
3019     'section'     => '',
3020     'description' => 'Disable all settings changes, for demos, except for the usernames given in the comma-separated list.',
3021     'type'        => [qw( checkbox text )],
3022   },
3023
3024   {
3025     'key'         => 'cust_main-edit_agent_custid',
3026     'section'     => 'UI',
3027     'description' => 'Enable editing of the agent_custid field.',
3028     'type'        => 'checkbox',
3029   },
3030
3031   {
3032     'key'         => 'cust_main-default_agent_custid',
3033     'section'     => 'UI',
3034     'description' => 'Display the agent_custid field when available instead of the custnum field.',
3035     'type'        => 'checkbox',
3036   },
3037
3038   {
3039     'key'         => 'cust_bill-default_agent_invid',
3040     'section'     => 'UI',
3041     'description' => 'Display the agent_invid field when available instead of the invnum field.',
3042     'type'        => 'checkbox',
3043   },
3044
3045   {
3046     'key'         => 'cust_main-auto_agent_custid',
3047     'section'     => 'UI',
3048     'description' => 'Automatically assign an agent_custid - select format',
3049     'type'        => 'select',
3050     'select_hash' => [ '' => 'No',
3051                        '1YMMXXXXXXXX' => '1YMMXXXXXXXX',
3052                      ],
3053   },
3054
3055   {
3056     'key'         => 'cust_main-default_areacode',
3057     'section'     => 'UI',
3058     'description' => 'Default area code for customers.',
3059     'type'        => 'text',
3060   },
3061
3062   {
3063     'key'         => 'mcp_svcpart',
3064     'section'     => '',
3065     'description' => 'Master Control Program svcpart.  Leave this blank.',
3066     'type'        => 'text', #select-part_svc
3067   },
3068
3069   {
3070     'key'         => 'cust_bill-max_same_services',
3071     'section'     => 'invoicing',
3072     '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.',
3073     'type'        => 'text',
3074   },
3075
3076   {
3077     'key'         => 'cust_bill-consolidate_services',
3078     'section'     => 'invoicing',
3079     'description' => 'Consolidate service display into fewer lines on invoices rather than one per service.',
3080     'type'        => 'checkbox',
3081   },
3082
3083   {
3084     'key'         => 'suspend_email_admin',
3085     'section'     => '',
3086     'description' => 'Destination admin email address to enable suspension notices',
3087     'type'        => 'text',
3088   },
3089
3090   {
3091     'key'         => 'email_report-subject',
3092     'section'     => '',
3093     'description' => 'Subject for reports emailed by freeside-fetch.  Defaults to "Freeside report".',
3094     'type'        => 'text',
3095   },
3096
3097   {
3098     'key'         => 'selfservice-head',
3099     'section'     => 'self-service',
3100     'description' => 'HTML for the HEAD section of the self-service interface, typically used for LINK stylesheet tags',
3101     'type'        => 'textarea', #htmlarea?
3102     'per_agent'   => 1,
3103   },
3104
3105
3106   {
3107     'key'         => 'selfservice-body_header',
3108     'section'     => 'self-service',
3109     'description' => 'HTML header for the self-service interface',
3110     'type'        => 'textarea', #htmlarea?
3111     'per_agent'   => 1,
3112   },
3113
3114   {
3115     'key'         => 'selfservice-body_footer',
3116     'section'     => 'self-service',
3117     'description' => 'HTML footer for the self-service interface',
3118     'type'        => 'textarea', #htmlarea?
3119     'per_agent'   => 1,
3120   },
3121
3122
3123   {
3124     'key'         => 'selfservice-body_bgcolor',
3125     'section'     => 'self-service',
3126     'description' => 'HTML background color for the self-service interface, for example, #FFFFFF',
3127     'type'        => 'text',
3128     'per_agent'   => 1,
3129   },
3130
3131   {
3132     'key'         => 'selfservice-box_bgcolor',
3133     'section'     => 'self-service',
3134     'description' => 'HTML color for self-service interface input boxes, for example, #C0C0C0',
3135     'type'        => 'text',
3136     'per_agent'   => 1,
3137   },
3138
3139   {
3140     'key'         => 'selfservice-text_color',
3141     'section'     => 'self-service',
3142     'description' => 'HTML text color for the self-service interface, for example, #000000',
3143     'type'        => 'text',
3144     'per_agent'   => 1,
3145   },
3146
3147   {
3148     'key'         => 'selfservice-link_color',
3149     'section'     => 'self-service',
3150     'description' => 'HTML link color for the self-service interface, for example, #0000FF',
3151     'type'        => 'text',
3152     'per_agent'   => 1,
3153   },
3154
3155   {
3156     'key'         => 'selfservice-vlink_color',
3157     'section'     => 'self-service',
3158     'description' => 'HTML visited link color for the self-service interface, for example, #FF00FF',
3159     'type'        => 'text',
3160     'per_agent'   => 1,
3161   },
3162
3163   {
3164     'key'         => 'selfservice-hlink_color',
3165     'section'     => 'self-service',
3166     'description' => 'HTML hover link color for the self-service interface, for example, #808080',
3167     'type'        => 'text',
3168     'per_agent'   => 1,
3169   },
3170
3171   {
3172     'key'         => 'selfservice-alink_color',
3173     'section'     => 'self-service',
3174     'description' => 'HTML active (clicked) link color for the self-service interface, for example, #808080',
3175     'type'        => 'text',
3176     'per_agent'   => 1,
3177   },
3178
3179   {
3180     'key'         => 'selfservice-font',
3181     'section'     => 'self-service',
3182     'description' => 'HTML font CSS for the self-service interface, for example, 0.9em/1.5em Arial, Helvetica, Geneva, sans-serif',
3183     'type'        => 'text',
3184     'per_agent'   => 1,
3185   },
3186
3187   {
3188     'key'         => 'selfservice-title_color',
3189     'section'     => 'self-service',
3190     'description' => 'HTML color for the self-service title, for example, #000000',
3191     'type'        => 'text',
3192     'per_agent'   => 1,
3193   },
3194
3195   {
3196     'key'         => 'selfservice-title_align',
3197     'section'     => 'self-service',
3198     'description' => 'HTML alignment for the self-service title, for example, center',
3199     'type'        => 'text',
3200     'per_agent'   => 1,
3201   },
3202   {
3203     'key'         => 'selfservice-title_size',
3204     'section'     => 'self-service',
3205     'description' => 'HTML font size for the self-service title, for example, 3',
3206     'type'        => 'text',
3207     'per_agent'   => 1,
3208   },
3209
3210   {
3211     'key'         => 'selfservice-title_left_image',
3212     'section'     => 'self-service',
3213     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3214     'type'        => 'image',
3215     'per_agent'   => 1,
3216   },
3217
3218   {
3219     'key'         => 'selfservice-title_right_image',
3220     'section'     => 'self-service',
3221     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3222     'type'        => 'image',
3223     'per_agent'   => 1,
3224   },
3225
3226   {
3227     'key'         => 'selfservice-menu_skipblanks',
3228     'section'     => 'self-service',
3229     'description' => 'Skip blank (spacer) entries in the self-service menu',
3230     'type'        => 'checkbox',
3231     'per_agent'   => 1,
3232   },
3233
3234   {
3235     'key'         => 'selfservice-menu_skipheadings',
3236     'section'     => 'self-service',
3237     'description' => 'Skip the unclickable heading entries in the self-service menu',
3238     'type'        => 'checkbox',
3239     'per_agent'   => 1,
3240   },
3241
3242   {
3243     'key'         => 'selfservice-menu_bgcolor',
3244     'section'     => 'self-service',
3245     'description' => 'HTML color for the self-service menu, for example, #C0C0C0',
3246     'type'        => 'text',
3247     'per_agent'   => 1,
3248   },
3249
3250   {
3251     'key'         => 'selfservice-menu_fontsize',
3252     'section'     => 'self-service',
3253     'description' => 'HTML font size for the self-service menu, for example, -1',
3254     'type'        => 'text',
3255     'per_agent'   => 1,
3256   },
3257   {
3258     'key'         => 'selfservice-menu_nounderline',
3259     'section'     => 'self-service',
3260     'description' => 'Styles menu links in the self-service without underlining.',
3261     'type'        => 'checkbox',
3262     'per_agent'   => 1,
3263   },
3264
3265
3266   {
3267     'key'         => 'selfservice-menu_top_image',
3268     'section'     => 'self-service',
3269     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3270     'type'        => 'image',
3271     'per_agent'   => 1,
3272   },
3273
3274   {
3275     'key'         => 'selfservice-menu_body_image',
3276     'section'     => 'self-service',
3277     'description' => 'Repeating image used for the body of the menu in the self-service interface, in PNG format.',
3278     'type'        => 'image',
3279     'per_agent'   => 1,
3280   },
3281
3282   {
3283     'key'         => 'selfservice-menu_bottom_image',
3284     'section'     => 'self-service',
3285     'description' => 'Image used for the bottom of the menu in the self-service interface, in PNG format.',
3286     'type'        => 'image',
3287     'per_agent'   => 1,
3288   },
3289
3290   {
3291     'key'         => 'selfservice-bulk_format',
3292     'section'     => 'deprecated',
3293     'description' => 'Parameter arrangement for selfservice bulk features',
3294     'type'        => 'select',
3295     'select_enum' => [ '', 'izoom-soap', 'izoom-ftp' ],
3296     'per_agent'   => 1,
3297   },
3298
3299   {
3300     'key'         => 'selfservice-bulk_ftp_dir',
3301     'section'     => 'deprecated',
3302     'description' => 'Enable bulk ftp provisioning in this folder',
3303     'type'        => 'text',
3304     'per_agent'   => 1,
3305   },
3306
3307   {
3308     'key'         => 'signup-no_company',
3309     'section'     => 'self-service',
3310     'description' => "Don't display a field for company name on signup.",
3311     'type'        => 'checkbox',
3312   },
3313
3314   {
3315     'key'         => 'signup-recommend_email',
3316     'section'     => 'self-service',
3317     'description' => 'Encourage the entry of an invoicing email address on signup.',
3318     'type'        => 'checkbox',
3319   },
3320
3321   {
3322     'key'         => 'signup-recommend_daytime',
3323     'section'     => 'self-service',
3324     'description' => 'Encourage the entry of a daytime phone number  invoicing email address on signup.',
3325     'type'        => 'checkbox',
3326   },
3327
3328   {
3329     'key'         => 'svc_phone-radius-default_password',
3330     'section'     => '',
3331     'description' => 'Default password when exporting svc_phone records to RADIUS',
3332     'type'        => 'text',
3333   },
3334
3335   {
3336     'key'         => 'svc_phone-allow_alpha_phonenum',
3337     'section'     => '',
3338     'description' => 'Allow letters in phone numbers.',
3339     'type'        => 'checkbox',
3340   },
3341
3342   {
3343     'key'         => 'svc_phone-domain',
3344     'section'     => '',
3345     'description' => 'Track an optional domain association with each phone service.',
3346     'type'        => 'checkbox',
3347   },
3348
3349   {
3350     'key'         => 'svc_phone-phone_name-max_length',
3351     'section'     => '',
3352     '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.',
3353     'type'        => 'text',
3354   },
3355
3356   {
3357     'key'         => 'default_phone_countrycode',
3358     'section'     => '',
3359     'description' => 'Default countrcode',
3360     'type'        => 'text',
3361   },
3362
3363   {
3364     'key'         => 'cdr-charged_party-accountcode',
3365     'section'     => '',
3366     'description' => 'Set the charged_party field of CDRs to the accountcode.',
3367     'type'        => 'checkbox',
3368   },
3369
3370   {
3371     'key'         => 'cdr-charged_party-accountcode-trim_leading_0s',
3372     'section'     => '',
3373     'description' => 'When setting the charged_party field of CDRs to the accountcode, trim any leading zeros.',
3374     'type'        => 'checkbox',
3375   },
3376
3377 #  {
3378 #    'key'         => 'cdr-charged_party-truncate_prefix',
3379 #    'section'     => '',
3380 #    'description' => 'If the charged_party field has this prefix, truncate it to the length in cdr-charged_party-truncate_length.',
3381 #    'type'        => 'text',
3382 #  },
3383 #
3384 #  {
3385 #    'key'         => 'cdr-charged_party-truncate_length',
3386 #    'section'     => '',
3387 #    'description' => 'If the charged_party field has the prefix in cdr-charged_party-truncate_prefix, truncate it to this length.',
3388 #    'type'        => 'text',
3389 #  },
3390
3391   {
3392     'key'         => 'cdr-charged_party_rewrite',
3393     'section'     => '',
3394     '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*.',
3395     'type'        => 'checkbox',
3396   },
3397
3398   {
3399     'key'         => 'cdr-taqua-da_rewrite',
3400     'section'     => '',
3401     '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.',
3402     'type'        => 'text',
3403   },
3404
3405   {
3406     'key'         => 'cust_pkg-show_autosuspend',
3407     'section'     => 'UI',
3408     'description' => 'Show package auto-suspend dates.  Use with caution for now; can slow down customer view for large insallations.',
3409     'type'        => 'checkbox',
3410   },
3411
3412   {
3413     'key'         => 'cdr-asterisk_forward_rewrite',
3414     'section'     => '',
3415     '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").',
3416     'type'        => 'checkbox',
3417   },
3418
3419   {
3420     'key'         => 'sg-multicustomer_hack',
3421     'section'     => '',
3422     'description' => "Don't use this.",
3423     'type'        => 'checkbox',
3424   },
3425
3426   {
3427     'key'         => 'sg-ping_username',
3428     'section'     => '',
3429     'description' => "Don't use this.",
3430     'type'        => 'text',
3431   },
3432
3433   {
3434     'key'         => 'sg-ping_password',
3435     'section'     => '',
3436     'description' => "Don't use this.",
3437     'type'        => 'text',
3438   },
3439
3440   {
3441     'key'         => 'sg-login_username',
3442     'section'     => '',
3443     'description' => "Don't use this.",
3444     'type'        => 'text',
3445   },
3446
3447   {
3448     'key'         => 'disable-cust-pkg_class',
3449     'section'     => 'UI',
3450     'description' => 'Disable the two-step dropdown for selecting package class and package, and return to the classic single dropdown.',
3451     'type'        => 'checkbox',
3452   },
3453
3454   {
3455     'key'         => 'queued-max_kids',
3456     'section'     => '',
3457     'description' => 'Maximum number of queued processes.  Defaults to 10.',
3458     'type'        => 'text',
3459   },
3460
3461   {
3462     'key'         => 'queued-sleep_time',
3463     'section'     => '',
3464     '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.',
3465     'type'        => 'text',
3466   },
3467
3468   {
3469     'key'         => 'cancelled_cust-noevents',
3470     'section'     => 'billing',
3471     'description' => "Don't run events for cancelled customers",
3472     'type'        => 'checkbox',
3473   },
3474
3475   {
3476     'key'         => 'agent-invoice_template',
3477     'section'     => 'invoicing',
3478     'description' => 'Enable display/edit of old-style per-agent invoice template selection',
3479     'type'        => 'checkbox',
3480   },
3481
3482   {
3483     'key'         => 'svc_broadband-manage_link',
3484     'section'     => 'UI',
3485     'description' => 'URL for svc_broadband "Manage Device" link.  The following substitutions are available: $ip_addr.',
3486     'type'        => 'text',
3487   },
3488
3489   #more fine-grained, service def-level control could be useful eventually?
3490   {
3491     'key'         => 'svc_broadband-allow_null_ip_addr',
3492     'section'     => '',
3493     'description' => '',
3494     'type'        => 'checkbox',
3495   },
3496
3497   {
3498     'key'         => 'tax-report_groups',
3499     'section'     => '',
3500     'description' => 'List of grouping possibilities for tax names on reports, one per line, "label op value" (op can be = or !=).',
3501     'type'        => 'textarea',
3502   },
3503
3504   {
3505     'key'         => 'tax-cust_exempt-groups',
3506     'section'     => '',
3507     '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).',
3508     'type'        => 'textarea',
3509   },
3510
3511   {
3512     'key'         => 'cust_main-default_view',
3513     'section'     => 'UI',
3514     'description' => 'Default customer view, for users who have not selected a default view in their preferences.',
3515     'type'        => 'select',
3516     'select_hash' => [
3517       #false laziness w/view/cust_main.cgi and pref/pref.html
3518       'basics'          => 'Basics',
3519       'notes'           => 'Notes',
3520       'tickets'         => 'Tickets',
3521       'packages'        => 'Packages',
3522       'payment_history' => 'Payment History',
3523       'change_history'  => 'Change History',
3524       'jumbo'           => 'Jumbo',
3525     ],
3526   },
3527
3528   {
3529     'key'         => 'enable_tax_adjustments',
3530     'section'     => 'billing',
3531     'description' => 'Enable the ability to add manual tax adjustments.',
3532     'type'        => 'checkbox',
3533   },
3534
3535   {
3536     'key'         => 'rt-crontool',
3537     'section'     => '',
3538     'description' => 'Enable the RT CronTool extension.',
3539     'type'        => 'checkbox',
3540   },
3541
3542   {
3543     'key'         => 'pkg-balances',
3544     'section'     => 'billing',
3545     'description' => 'Enable experimental package balances.  Not recommended for general use.',
3546     'type'        => 'checkbox',
3547   },
3548
3549   {
3550     'key'         => 'pkg-addon_classnum',
3551     'section'     => 'billing',
3552     'description' => 'Enable the ability to restrict additional package orders based on package class.',
3553     'type'        => 'checkbox',
3554   },
3555
3556   {
3557     'key'         => 'cust_main-edit_signupdate',
3558     'section'     => 'UI',
3559     'descritpion' => 'Enable manual editing of the signup date.',
3560     'type'        => 'checkbox',
3561   },
3562
3563   {
3564     'key'         => 'svc_acct-disable_access_number',
3565     'section'     => 'UI',
3566     'descritpion' => 'Disable access number selection.',
3567     'type'        => 'checkbox',
3568   },
3569
3570   {
3571     'key'         => 'cust_bill_pay_pkg-manual',
3572     'section'     => 'UI',
3573     'description' => 'Allow manual application of payments to line items.',
3574     'type'        => 'checkbox',
3575   },
3576
3577   {
3578     'key'         => 'cust_credit_bill_pkg-manual',
3579     'section'     => 'UI',
3580     'description' => 'Allow manual application of credits to line items.',
3581     'type'        => 'checkbox',
3582   },
3583
3584   {
3585     'key'         => 'breakage-days',
3586     'section'     => 'billing',
3587     '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.',
3588     'type'        => 'text',
3589     'per_agent'   => 1,
3590   },
3591
3592   {
3593     'key'         => 'breakage-pkg_class',
3594     'section'     => 'billing',
3595     'description' => 'Package class to use for breakage reconciliation.',
3596     'type'        => 'select-pkg_class',
3597   },
3598
3599   {
3600     'key'         => 'disable_cron_billing',
3601     'section'     => 'billing',
3602     '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.',
3603     'type'        => 'checkbox',
3604   },
3605
3606   {
3607     'key'         => 'svc_domain-edit_domain',
3608     'section'     => '',
3609     'description' => 'Enable domain renaming',
3610     'type'        => 'checkbox',
3611   },
3612
3613   {
3614     'key'         => 'enable_legacy_prepaid_income',
3615     'section'     => '',
3616     '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.",
3617     'type'        => 'checkbox',
3618   },
3619
3620   { key => "apacheroot", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3621   { key => "apachemachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3622   { key => "apachemachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3623   { key => "bindprimary", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3624   { key => "bindsecondaries", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3625   { key => "bsdshellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3626   { key => "cyrus", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3627   { key => "cp_app", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3628   { key => "erpcdmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3629   { key => "icradiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3630   { key => "icradius_mysqldest", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3631   { key => "icradius_mysqlsource", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3632   { key => "icradius_secrets", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3633   { key => "maildisablecatchall", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3634   { key => "mxmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3635   { key => "nsmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3636   { key => "arecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3637   { key => "cnamerecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3638   { key => "nismachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3639   { key => "qmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3640   { key => "radiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3641   { key => "sendmailconfigpath", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3642   { key => "sendmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3643   { key => "sendmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3644   { key => "shellmachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3645   { key => "shellmachine-useradd", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3646   { key => "shellmachine-userdel", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3647   { key => "shellmachine-usermod", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3648   { key => "shellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3649   { key => "radiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3650   { key => "textradiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3651   { key => "username_policy", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3652   { key => "vpopmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3653   { key => "vpopmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3654   { key => "safe-part_pkg", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3655   { key => "selfservice_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3656   { key => "signup_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3657   { key => "signup_server-email", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3658   { key => "vonage-username", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3659   { key => "vonage-password", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3660   { key => "vonage-fromnumber", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
3661
3662 );
3663
3664 1;
3665