Documentation: Migrate reports documentation from 2.1
[working/Evergreen.git] / docs / reports / reporter_folder.txt
1 [[reporter_folders]]\r
2 Folders\r
3 -------\r
4 \r
5 indexterm:[reports, folders]\r
6 \r
7 There are three main components to reports: _Templates_, _Reports_, and _Output_. \r
8 Each of these components must be stored in a folder. Folders can be private \r
9 (accessible to your login only) or shared with other staff at your library, \r
10 other libraries in your system or consortium. It is also possible to selectively \r
11 share \r
12 only certain folders and/or subfolders.\r
13 \r
14 There are two parts to the folders pane. The _My Folders_ section contains folders \r
15 created with your Evergreen account. Folders that other users have shared with \r
16 you appear in the _Shared Folders_ section under the username of the sharing \r
17 account.\r
18 \r
19 image::media/folder-1.png[folder-1]\r
20 \r
21 [[reporter_creating_folders]]\r
22 Creating Folders\r
23 ~~~~~~~~~~~~~~~~\r
24 \r
25 \r
26 indexterm:[reports, folders, creating]\r
27 \r
28 Whether you are creating a report from scratch or working from a shared template \r
29 you must first create at least one folder.\r
30 \r
31 The steps for creating folders are similar for each reporting function. It is \r
32 easier to create folders for templates, reports, and output all at once at the \r
33 beginning, though it is possible to do it before each step. This example \r
34 demonstrates creating a folder for a template.\r
35 \r
36 . Click on _Templates_ in the _My Folders_ section.\r
37 . Name the folder. Select _Share_ or _Do not share_ from the dropdown menu.\r
38 . If you want to share your folder, select who you want to share this folder \r
39 with from the dropdown menu.\r
40 . Click _Create Sub Folder_.\r
41 . Click _OK_.\r
42 . Next, create a folder for the report definition to be saved to. Click on \r
43 _Reports_.\r
44 . Repeat steps 2-5 to create a Reports folder also called _Circulation_.\r
45 . Finally, you need to create a folder for the report’s output to be saved in. \r
46 Click on _Output_.\r
47 . Repeat steps 2-5 to create an Output folder named _Circulation_.\r
48 \r
49 \r
50 TIP: Using a parallel naming scheme for folders in Templates, Reports, \r
51 and Output helps keep your reports organized and easier to find\r
52 \r
53 The folders you just created will now be visible by clicking the arrows in _My \r
54 Folders_. Bracketed after the folder name is whom the folder is shared with. For \r
55 example, _Circulation (BNCLF)_ is shared with the North Coast Library Federation. \r
56 If it is not a shared folder there will be nothing after the folder name. You \r
57 may create as many folders and sub-folders as you like.\r
58 \r
59 Managing Folders\r
60 ~~~~~~~~~~~~~~~~\r
61 \r
62 indexterm:[reports, folders, managing]\r
63 \r
64 Once a folder has been created you can change the name, delete it, create a new \r
65 subfolder, or change the sharing settings. This example demonstrates changing a \r
66 folder name; the other choices follow similar steps\r
67 \r
68 . Click on the folder that you wish to rename.\r
69 . Click _Manage Folder_.\r
70 . Select _Change folder name_ from the dropdown menu and click _Go_.\r
71 . Enter the new name and click _Submit_.\r
72 . Click _OK_.\r
73 . You will get a confirmation box that the _Action Succeeded_. Click _OK_.\r
74 \r
75 \r
76 \r