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