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