source: TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/templates/oai_info_editor_help.html @ 5255

Subversion URL:
Revision 5255, 9.4 KB checked in by cbyrom, 10 years ago (diff)

Extend OAI Info editor documentation and help pages + improve the
setup config + extend test suite and fix problem with setting
email addresses in providerinfo.

1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "">
2<html xmlns=""
3        xmlns:py="" 
4        xmlns:xi="">
5        <xi:include href="layout.html" />
6        <head>
7        <title py:content="c.title">title</title>
8    </head>
9  <body class="submit">
10      <panelTab>Editor</panelTab>
11        <div id="contents">
12            <div class="metadata">
13                            <h3>  $c.title
14                    </h3>
15                                <h2>Contents</h2>
16                                <div class="headingblock">                 
17                    <ol>
18                        <li><a href="#intro">Introduction</a></li>
19                        <li><a href="#home">Home page</a></li>
20                        <li><a href="#pihome">Provider info page</a></li>
21                        <li><a href="#piedit">Edit provider info page</a></li>
22                        <li><a href="#providerinfo">Creating/editing/deleting provider info</a></li>
23                        <li><a href="#repositoryinfo">Creating/editing repository info</a></li>
24                        <li><a href="#harvest">Harvesting data</a></li>
25                    </ol>
26                    </div>
27                    <a name="intro"><h2>Introduction</h2></a>
28                                <div class="headingblock">                 
29                            <p>
30                            This web application allows the creation and update of provider and repository
31                            information for metadata document harvesting via OAI.  Admin users can create new
32                            provider information and providers can then access and edit this information.
33                            </p>
34                            <p>
35                            The information stored by the system is used to run a daily harvest of the
36                            various repository data.  Additionally, functionality is exposed by the
37                            application to instigate an immediate harvest of a specified repository.
38                            </p>
39                                </div>
40                    <a name="home"><h2>Home page</h2></a>
41                                <div class="headingblock">                 
42                    <p>
43                    The home page is available <a href="${h.url_for('home')}">
44                    here</a>; this provides links to the pages for the different
45                    providers available to the system (as described in the next
46                    <a href="#pihome">section</a>).  NB, users with admin rights can
47                    view access all provider info in the system from this page.  They
48                    can also elect to create new provider info from this page, using the
49                    'Create new provider info' link.  Specific
50                    providers will only be able to access provider info they have been
51                    specificially authorised to view.
52                    </p>
53                    </div>
55                    <a name="pihome"><h2>Provider info page</h2></a>
56                                <div class="headingblock">                 
57                    <p>
58                    All provider information available to the current user is displayed
59                    in the provider information page.  Two types of users exist in the system
60                    and these have access to different functionality as follows:
61                    <dl>
62                    <dt><b>Admin users</b></dt>
63                    <dd>
64                    Admin users can view all provider and repository info currently stored
65                    in the system.  The 'Create new provider info' link allows the creation
66                    of new provider info data and each provider info section has associated
67                    'Edit', 'Delete' and 'Harvest' functions.
68                    </dd>
69                    <dt><b>Standard (provider) users</b></dt>
70                    <dd>
71                    Standard users represent the actual providers listed in the system.  Their
72                    provider info pages will only list data they are actually associated with.
73                    Like the admin user, 'Edit' and 'Harvest' functions are available, however
74                    the 'Delete' function is not.
75                    </dd>
76                    </dl>
77                    </p>
78                    </div>
80                    <a name="piedit"><h2>Edit provider info page</h2></a>
81                                <div class="headingblock">                 
82                    <p>
83                    Clicking on an 'Edit' link in the provider info page opens the edit
84                    page for the associated provider.  Here the user can add or update
85                    the following information:
87                    <dl>
88                            <dt><b>Provider Name</b></dt><dd>
89                            the name of the provider [mandatory] - NB editable only by admin users
90                            </dd>
91                            <dt><b>Provider Email</b></dt><dd>
92                            the email address of the provider - NB, this is primarily used for communicating
93                            the results of the ingest process (section <a href="${h.url_for('harvest')}">
94                        Harvesting Data</a>).
95                            </dd>
96                            <dt><b>Repository Name</b></dt>
97                            <dd>
98                            the name for the repository [mandatory]
99                            </dd>
100                                        <dt><b>Base URL</b></dt>
101                                        <dd>
102                                        the OAI provider URL representing the repository [mandatory]
103                                        </dd>
104                                        <dt><b>SetSpec</b></dt>
105                                        <dd>
106                                        an identifier for a subgroup of metadata files in the OAI provider
107                                        </dd>
108                                        <dt><b>Format</b></dt>
109                                        <dd>
110                                        the metadata format
111                                        </dd>
112                                        <dt><b>Split by set</b></dt>
113                                        <dd>
114                                        if a setspec identifier has been set, if this checkbox is ticked, the
115                                        harvested records will be placed in a subdirectory on the harvester
116                                        system
117                                        </dd>
118                                </dl>
119                                </p>
120                                <p>
121                                Additionally, a link 'Add new repository data' is available; if clicked
122                                a new row is exposed to input additional repository information.  If several
123                                repositories need to be defined, add these one at a time, clicking 'Update'
124                                inbetween additions.
125                                </p>
126                                <p>
127                                To save changes, click 'Update'.  The application will then returned to the
128                                provider info page.
129                                </p>
130                    </div>
133                    <a name="providerinfo"><h2>Creating/editing/deleting provider info</h2></a>
134                                <div class="headingblock">                 
135                    <p>
136                    The following functions are available with the application:
137                    <dl>
138                    <dt>
139                    <b>Create Provider Info</b> [admin users only]
140                    </dt>
141                    <dd>
142                    On either the home page or the provider info page, click the 'Create new provider info'
143                    link to create a new provider info record.  Having added the data, click 'Update'.  Control
144                    will return to the home page - and a new link will be visible to the newly
145                    added provider data
146                    </dd>
147                    <dt>
148                    <b>Edit Provider Info</b>
149                    </dt>
150                    <dd>
151                    On the provider info page, click the 'Edit' link next to a particular
152                    provider info record.  The provider info edit page will then open and
153                    the associated data can be adjusted as required.
154                    </dd>
155                    <dt>
156                    <b>Delete Provider Info</b> [admin users only]
157                    </dt>
158                    <dd>
159                    On the provider info page, click the 'Delete' link next to a particular
160                    provider info record.  A confirmation dialogue will appear to ensure
161                    that the deletion is actually desired.  If this is confirmed, the
162                    provider info will then be deleted open and
163                    control will return to the application home page.  A pop up message will
164                    indicate the outcome of the delete.
165                    </dd>
166                    </dl>
167                    </p>
168                    </div>
170                    <a name="repositoryinfo"><h2>Creating/editing/deleting repository info</h2></a>
171                                <div class="headingblock">                 
172                    <p>
173                    On the provider info page, click the 'Edit' link next to a particular
174                    provider info record.  The provider info edit page will then open and
175                    the associated data can be adjusted as required.  New repository data
176                    can be added by clicking the 'Add new repository data' link.  When the
177                    data is as required, click 'Update' to save it to the system.  To delete
178                    a repository info record, just delete all its associated text and click
179                    'Update'.
180                    </p>
181                    </div>
183                    <a name="harvest"><h2>Harvesting data</h2></a>
184                                <div class="headingblock">                 
185                    <p>
186                    On the provider info page, click the 'Harvest' button next to a particular
187                    provider info record.  A harvest will then be undertaken.  Note this is a
188                    two stage process:
189                    <ol>
190                    <li>
191                    The metadata (or specified subset of) exposed by the OAI provider is harvested
192                    to the BADC system.
193                    </li>
194                    <li>
195                    If the harvest completes successfully, the harvested documents are then
196                    ingested into the BADC Discovery Service.
197                    </li>
198                    </ol>
199                    </p>
200                    <p>
201                    The outcome of both of the harvest operation, together with basic details (e.g.
202                    number of records harvested) is then displayed to the user.  If there is
203                    a provider email address available, the results of the ingest will be mailed
204                    to that; NB, the ingest is rather a slow process so it is instigated asynchronously.
205                    </p>
206                    <p>
207                    Note, although users can request harvests manually, these will also
208                    happen automatically, on a daily basis, by the BADC harvester.
209                    </p>
210                    </div>
211                </div>
212        </div>
213  </body>
Note: See TracBrowser for help on using the repository browser.