Docs: Updated usage of autogen.sh to not use param 'u'
[working/Evergreen.git] / docs / admin_initial_setup / describing_your_organization.txt
1 Describing your organization
2 ============================
3
4 Your Evergreen system is almost ready to go. You'll need to add each of the
5 libraries that will be using your Evergreen system. If you're doing this for a
6 consortium, you'll have to add your consortium as a whole, and all the
7 libraries and branches that are members of the consortium. In this chapter,
8 we'll talk about how to get the Evergreen system to see all your libraries, how
9 to set each one up, and how to edit all the details of each one. 
10
11 Organization Unit Types 
12 -----------------------
13 The term _Organization Unit Types_ refers to levels in the hierarchy of your
14 library system(s). Examples could include: All-Encompassing Consortium, Library
15 System, Branch, Bookmobile, Sub-Branch, etc. 
16
17 You can add or remove organizational unit types, and rename them as needed to
18 match the organizational hierarchy that matches the libraries using your
19 installation of Evergreen. Organizational unit types should never have proper
20 names since they are only generic types. 
21
22 When working with configuration, settings, and permissions, it is very
23 important to be careful of the Organization Unit *Context Location* - this is the
24 organizational unit to which the configuration settings are being applied. If,
25 for example, a setting is applied at the Consortium context location, all child
26 units will inherit that setting. If a specific branch location is selected,
27 only that branch and its child units will have the setting applied. The levels
28 of the hierarchy to which settings can be applied are often referred to in
29 terms of "depth" in various configuration interfaces. In a typical hierarchy,
30 the consortium has a depth of 0, the system is 1, the branch is 2, and any
31 bookmobiles or sub-branches is 3.
32
33 Create and edit Organization Unit Types 
34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35 . Open *Admin > Server Administration > Organization Types*.
36 . In the left panel, expand the *Organization Unit Types* hierarchy. 
37 . Click on a organization type to edit the existing type or to add a new
38   organization unit. 
39 . A form opens in the right panel, displaying the data for the selected
40   organization unit. 
41 . Edit the fields as required and click *Save*. 
42
43 To create a new dependent organization unit, click *New Child*. The new child
44 organization unit will appear in the left panel list below the parent.
45 Highlight the new unit and edit the data as needed, click *Save*
46
47 Organizational Units 
48 --------------------
49 'Organizational Units' are the specific instances of the organization unit types
50 that make up your library's hierarchy. These will have distinctive proper names
51 such as Main Street Branch or Townsville Campus. 
52
53 Remove or edit default Organizational Units 
54 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55 After installing the Evergreen software, the default CONS, SYS1, BR1, etc.,
56 organizational units remain. These must be removed or edited to reflect actual
57 library entities. 
58
59 Create and edit Organizational Units 
60 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
61 . Open *Admin > Server Administration > Organizational Units*.
62 . In the left panel, expand the the Organizational Units hierarchy, select a
63   unit.
64 . A form opens in the right panel, displaying the data for the selected
65   organizational unit.
66 . To edit the existing, default organizational unit, enter system or library
67   specific data in the form; complete all three tabs: Main Settings, Hours
68   of Operation, Addresses.
69 . Click *Save*.
70
71 To create a new dependent organizational unit, click *New Child*. The new child
72 will appear in the hierarchy list below the parent unit. Click on the new unit
73 and edit the data, click *Save*
74
75 Organizational Unit data
76 ~~~~~~~~~~~~~~~~~~~~~~~~
77 The *Addresses* tab allows you to enter library contact information. Library
78 Phone number, email address, and addresses are used in patron email
79 notifications, hold slips, and transit slips. The Library address tab is broken
80 out into four address types: Physical Address, Holds Address, Mailing Address,
81 ILL Address. 
82
83 The *Hours of Operation* tab is where you enter regular, weekly hours. Holiday
84 and other closures are set in the *Closed Dates Editor*. Hours of operation and
85 closed dates impact due dates and fine accrual.  
86
87 After Changing Organization Unit Data
88 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
89
90 After you change Org Unit data, you must run the autogen.sh script.  
91 This script updates the Evergreen organization tree and fieldmapper IDL.  
92 You will get unpredictable results if you don't run this after making changes.
93
94 Run this script as the *opensrf* Linux account.
95
96 [source, bash]
97 ------------------------------------------------------------------------------
98 autogen.sh
99 ------------------------------------------------------------------------------
100
101 Set closed dates using the Closed Dates Editor 
102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103 . Open *Admin > Local Administration > Closed Dates Editor*.
104 . Select type of closure: typically Single Day or Multiple Day.
105 . Click the Calendar gadget to select the All Day date or starting and ending
106   dates.
107 . Enter a Reason for closure (optional).
108 . Click *Apply* to all of my libraries if your organizational unit has children
109   units that will also be closed.
110 . Click *Save*.
111
112 Now that your organizational structure is established, you can begin
113 configuring permissions for the staff users of your Evergreen system.