4 use vars qw( @ISA @EXPORT_OK );
12 $FS::svc_domain::whois_hack = 1;
13 $FS::svc_domain::whois_hack = 1;
15 @ISA = qw( Exporter );
16 @EXPORT_OK = qw( create_initial_data );
20 FS::Setup - Database setup
28 Currently this module simply provides a place to store common subroutines for
39 sub create_initial_data {
42 my $oldAutoCommit = $FS::UID::AutoCommit;
43 local $FS::UID::AutoCommit = 0;
44 $FS::UID::AutoCommit = 0;
49 populate_initial_data(%opt);
55 if ( $oldAutoCommit ) {
56 dbh->commit or die dbh->errstr;
61 sub populate_locales {
64 use Locale::SubCountry;
65 use FS::cust_main_county;
68 foreach my $country ( sort map uc($_), all_country_codes ) {
70 my $subcountry = eval { new Locale::SubCountry($country) };
71 my @states = $subcountry ? $subcountry->all_codes : undef;
73 if ( !scalar(@states) || ( scalar(@states)==1 && !defined($states[0]) ) ) {
75 _add_locale( 'country'=>$country );
79 if ( $states[0] =~ /^(\d+|\w)$/ ) {
80 @states = map $subcountry->full_name($_), @states
83 foreach my $state ( @states ) {
84 _add_locale( 'country'=>$country, 'state'=>$state);
92 sub populate_addl_locales {
96 'FM' => 'Federated States of Micronesia',
97 'MH' => 'Marshall Islands',
99 'AA' => "Armed Forces Americas (except Canada)",
100 'AE' => "Armed Forces Europe / Canada / Middle East / Africa",
101 'AP' => "Armed Forces Pacific",
105 foreach my $country ( keys %addl ) {
106 foreach my $state ( keys %{ $addl{$country} } ) {
107 # $longname = $addl{$country}{$state};
108 _add_locale( 'country'=>$country, 'state'=>$state);
115 my $cust_main_county = new FS::cust_main_county( { 'tax'=>0, @_ });
116 my $error = $cust_main_county->insert;
117 die $error if $error;
120 sub populate_initial_data {
123 my $data = initial_data(%opt);
125 foreach my $table ( keys %$data ) {
127 my $class = "FS::$table";
131 my @records = @{ $data->{$table} };
133 foreach my $record ( @records ) {
134 my $args = delete($record->{'_insert_args'}) || [];
135 my $object = $class->new( $record );
136 my $error = $object->insert( @$args );
137 die "error inserting record into $table: $error\n"
148 #tie my %hash, 'Tie::DxHash',
149 tie my %hash, 'Tie::IxHash',
153 { 'groupname' => 'Superuser' },
157 'part_bill_event' => [
159 'event' => 'Batch card',
161 'eventcode' => '$cust_bill->batch_card(%options);',
163 'plan' => 'batch-card',
166 'event' => 'Send invoice',
168 'eventcode' => '$cust_bill->send();',
173 'event' => 'Send invoice',
175 'eventcode' => '$cust_bill->send();',
180 'event' => 'Send invoice',
182 'eventcode' => '$cust_bill->send();',
187 'event' => 'Suspend',
189 'eventcode' => '$cust_bill->suspend();',
193 #{ 'payby' => 'DCLN',
194 # 'event' => 'Retriable',
196 # 'eventcode' => '$cust_bill_event->retriable();',
198 # 'plan' => 'retriable',
202 #you must create a service definition. An example of a service definition
203 #would be a dial-up account or a domain. First, it is necessary to create a
204 #domain definition. Click on View/Edit service definitions and Add a new
205 #service definition with Table svc_domain (and no modifiers).
208 'svcdb' => 'svc_domain',
212 #Now that you have created your first service, you must create a package
213 #including this service which you can sell to customers. Zero, one, or many
214 #services are bundled into a package. Click on View/Edit package
215 #definitions and Add a new package definition which includes quantity 1 of
216 #the svc_domain service you created above.
218 { 'pkg' => 'System Domain',
219 'comment' => '(NOT FOR CUSTOMERS)',
223 'pkg_svc' => { 1 => 1 }, # XXX
224 'primary_svc' => 1, #XXX
233 #After you create your first package, then you must define who is able to
234 #sell that package by creating an agent type. An example of an agent type
235 #would be an internal sales representitive which sells regular and
236 #promotional packages, as opposed to an external sales representitive
237 #which would only sell regular packages of services. Click on View/Edit
238 #agent types and Add a new agent type.
240 { 'atype' => 'internal' },
243 #Allow this agent type to sell the package you created above.
245 { 'typenum' => 1, #XXX
250 #After creating a new agent type, you must create an agent. Click on
251 #View/Edit agents and Add a new agent.
253 { 'agent' => 'Internal',
254 'typenum' => 1, # XXX
258 #Set up at least one Advertising source. Advertising sources will help you
259 #keep track of how effective your advertising is, tracking where customers
260 #heard of your service offerings. You must create at least one advertising
261 #source. If you do not wish to use the referral functionality, simply
262 #create a single advertising source only. Click on View/Edit advertising
263 #sources and Add a new advertising source.
265 { 'referral' => 'Internal', },
268 #Click on New Customer and create a new customer for your system accounts
269 #with billing type Complimentary. Leave the First package dropdown set to
272 { 'agentnum' => 1, #XXX
275 'last' => 'Accounts',
276 'address1' => '1234 System Lane',
277 'city' => 'Systemtown',
282 'payinfo' => 'system', #or something
283 'paydate' => '1/2037',
287 #From the Customer View screen of the newly created customer, order the
288 #package you defined above.
290 { 'custnum' => 1, #XXX
295 #From the Package View screen of the newly created package, choose
296 #(Provision) to add the customer's service for this new package.
297 #Add your own domain.
299 { 'domain' => $opt{'domain'},
302 'action' => 'N', #pseudo-field
306 #Go back to View/Edit service definitions on the main menu, and Add a new
307 #service definition with Table svc_acct. Select your domain in the domsvc
308 #Modifier. Set Fixed to define a service locked-in to this domain, or
309 #Default to define a service which may select from among this domain and
310 #the customer's domains.
321 sub populate_access {
324 use FS::access_right;
326 foreach my $rightname ( FS::AccessRight->rights ) {
327 my $access_right = new FS::access_right {
328 'righttype' => 'FS::access_group',
329 'rightobjnum' => 1, #$supergroup->groupnum,
330 'rightname' => $rightname,
332 my $ar_error = $access_right->insert;
333 die $ar_error if $ar_error;
336 #foreach my $agent ( qsearch('agent', {} ) ) {
337 my $access_groupagent = new FS::access_groupagent {
338 'groupnum' => 1, #$supergroup->groupnum,
339 'agentnum' => 1, #$agent->agentnum,
341 my $aga_error = $access_groupagent->insert;
342 die $aga_error if $aga_error;
347 sub populate_msgcat {
349 use FS::Record qw(qsearch);
352 foreach my $del_msgcat ( qsearch('msgcat', {}) ) {
353 my $error = $del_msgcat->delete;
354 die $error if $error;
357 my %messages = msgcat_messages();
359 foreach my $msgcode ( keys %messages ) {
360 foreach my $locale ( keys %{$messages{$msgcode}} ) {
361 my $msgcat = new FS::msgcat( {
362 'msgcode' => $msgcode,
364 'msg' => $messages{$msgcode}{$locale},
366 my $error = $msgcat->insert;
367 die $error if $error;
373 sub msgcat_messages {
376 # 'en_US' => 'Message',
381 'passwords_dont_match' => {
382 'en_US' => "Passwords don't match",
386 'en_US' => 'Invalid credit card number',
389 'unknown_card_type' => {
390 'en_US' => 'Unknown card type',
397 'empty_password' => {
398 'en_US' => 'Empty password',
401 'no_access_number_selected' => {
402 'en_US' => 'No access number selected',
406 'en_US' => 'Illegal (text)',
407 #'en_US' => 'Only letters, numbers, spaces, and the following punctuation symbols are permitted: ! @ # $ % & ( ) - + ; : \' " , . ? / in field',
410 'illegal_or_empty_text' => {
411 'en_US' => 'Illegal or empty (text)',
412 #'en_US' => 'Only letters, numbers, spaces, and the following punctuation symbols are permitted: ! @ # $ % & ( ) - + ; : \' " , . ? / in required field',
415 'illegal_username' => {
416 'en_US' => 'Illegal username',
419 'illegal_password' => {
420 'en_US' => 'Illegal password (',
423 'illegal_password_characters' => {
424 'en_US' => ' characters)',
427 'username_in_use' => {
428 'en_US' => 'Username in use',
431 'illegal_email_invoice_address' => {
432 'en_US' => 'Illegal email invoice address',
436 'en_US' => 'Illegal (name)',
437 #'en_US' => 'Only letters, numbers, spaces and the following punctuation symbols are permitted: , . - \' in field',
441 'en_US' => 'Illegal (phone)',
446 'en_US' => 'Illegal (zip)',
451 'en_US' => 'Expired card',
455 'en_US' => 'Day Phone',
459 'en_US' => 'Night Phone',
462 'svc_external-id' => {
463 'en_US' => 'External ID',
466 'svc_external-title' => {