new admin documentation, quick one-pkg order
[freeside.git] / httemplate / docs / admin.html
1 <head>
2   <title>Administration</title>
3 </head>
4 <body>
5   <h1>Administration</h1>
6 </body>
7 <ul>
8   <li>Open up the root of the Freeside document tree in your web
9   browser.  For example, if you created the Freeside document tree in   
10   /home/httpd/html/freeside, and your web browser's DocumentRoot is
11   /home/httpd/html, open https://your_host/freeside/. Replace
12   "your_host" with the name or network address of your web server.
13
14   <li>Once in the Freeside web interface, you must first create a
15   service definition.  An example of a service definition would be a dial-up
16   account or a domain.  For starters, it is necessary to create a domain
17   definition.  Click on <u>View/Edit service definitions</u> and
18   <u>Add a new service definition</u> with <i>Table</i> <b>svc_domain</b>
19   (and no modifiers).
20
21   <li>Now that you have created your first service, you must create a package
22   including this service which you can sell to customers.  Zero, one, or many
23   services are bundled into a package.  Click on <u>View/Edit package
24   definitions</u> and <u>Add a new package definition</u> which includes
25   quantity <b>1</b> of the svc_domain service you created above.
26
27   <li>After you create your first package, then you must define who is
28   able to sell that package by creating an agent type.  An example of
29   an agent type would be an internal sales representitive which sells
30   regular and promotional packages, as opposed to an external sales
31   representitive which would only sell regular packages of services.  Click on
32   <u>View/Edit agent types</u> and <u>Add a new agent type</u>.  Allow this
33   agent type to sell the package you created above.
34
35   <li>After creating a new agent type, you must create an agent.  Click on
36   <u>View/Edit agents</u> and <u>Add a new agent</u>.
37
38   <li>Set up at least one referral.  Referrals will help you keep track of how
39   effective your advertising is, by helping you keep track of where customers
40   heard of your service offerings.  You must create at least one referral.  If
41   you do not wish to use the referral functionality, simply create a single
42   referral only.  Click on <u>View/Edit referrals</u> and <u>Add a new
43   referral</u>.
44
45   <li>Click on <u>New Customer</u> and create a new customer for your system
46   accounts with billing type <b>Complimentary</b>.  
47
48   <li>From the Customer View screen of the newly created customer, order the
49   package you defined above.
50
51   <li>From the Package View screen of the newly cretaed package, choose
52   <u>(Add)</u> to add the customer's service for this new package.
53
54   <li>Add your own domain, and note down the assigned <b>Service #</b>.
55
56   <li>Go back to <u>View/Edit service definitions</u> on the main menu, and
57   <u>Add a new service definition</u> with <i>Table</i> <b>svc_acct</b>.  Put
58   the <b>Service #</b> for your domain in the <b>domsvc</b> Modifier.  Set
59   <b>Fixed</b> to define a service locked-in to this domain, or <b>Default</b>
60   to define a service which may select from among this domain and the
61   customer's domains.
62
63   <li><table><tr>
64     <td> Create at least POP (Point of Presence) by selecting
65         <u>View/Edit POPs</u> from the main menu.</td>
66     <th align="left"> OR </th>
67     <td>If you are not doing dialup, set slipip to fixed and blank for all your
68         Service Definitions which have Table <b>svc_acct</b>.</td>
69   </tr></table>
70
71   <li>If you are using Freeside to keep track of sales taxes, define tax
72   information for your locales by clicking on the <u>View/Edit locales and tax
73   rates</b> on the main menu.
74
75 </ul>
76 </body>
77 </html>