Changeset 5242 for TI01-discovery/trunk


Ignore:
Timestamp:
30/04/09 16:21:02 (10 years ago)
Author:
cbyrom
Message:

Add help page to application + tidy up codebase remove uneccessary code
and fixing name references, etc.

Location:
TI01-discovery/trunk/OAIInfoEditor
Files:
17 edited

Legend:

Unmodified
Added
Removed
  • TI01-discovery/trunk/OAIInfoEditor/editor.config

    r5239 r5242  
    11# 
    2 # Vocab Term Editor Configuration File 
     2# OAI Info Editor Configuration File 
    33# - see toplevel README.txt file for config instructions 
    44# 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/controllers/edit.py

    r5239 r5242  
    11''' 
    2  Class representing pylons controller for the input and edit of work requests to 
    3  update/create new Vocab Terms 
     2 Class representing pylons controller for the input and edit of provider and 
     3 repository info 
    44   
    55 @author: C Byrom, Tessella Feb 2009 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/dal/editorfileclient.py

    r5240 r5242  
    2525        @keyword configFile: myConfig object to use to set up client 
    2626        ''' 
    27         logging.info("Initialising EditorFileClient object") 
     27        logging.debug("Initialising EditorFileClient object") 
    2828        self.cf = configFile 
    2929        if configFile: 
     
    3636        # - primarily for testing purposes 
    3737        self.pic = None 
    38         logging.info("EditorFileClient initialised") 
     38        logging.debug("EditorFileClient initialised") 
    3939         
    4040 
     
    120120        pic = None 
    121121        if os.path.isfile(fileName): 
    122             logging.debug("- config data already exists for this vocab list - load this now") 
     122            logging.debug("- data already exists - load this now") 
    123123            pic = self.__loadProviderInfoFile(fileName) 
    124124             
    125125        else: 
    126             logging.debug(" - no data found for this list - setting up a new data collection") 
     126            logging.debug(" - no data found - setting up a new data collection") 
    127127            pic = ProviderInfoCollection(fileName)  
    128128 
     
    138138        @return ProviderInfoCollection created 
    139139        ''' 
    140         logging.info("Creating or updating provider info collection file") 
     140        logging.debug("Creating or updating provider info collection file") 
    141141         
    142142        fileName = self.__generateFileName() 
    143143        if os.path.isfile(fileName): 
    144             logging.info("- found existing file - creating backup") 
     144            logging.debug("- found existing file - creating backup") 
    145145            logging.debug("- this will be a backup file") 
    146146             
    147147            backupFileName = self.__generateFileName(isBackup = True) 
    148             logging.info("- backup change request collection file, '%s'" %backupFileName) 
     148            logging.debug("- backup provider info collection file, '%s'" %backupFileName) 
    149149             
    150150            shutil.copy(fileName, backupFileName) 
     
    156156            pic.version = str(int(pic.version) + 1) 
    157157 
    158         logging.info("- create provider info collection file, '%s'" %fileName) 
     158        logging.debug("- create provider info collection file, '%s'" %fileName) 
    159159        createFile(fileName, pic.toXMLString()) 
    160160        return pic 
     
    165165        Create a new provider info record 
    166166        @param providerInfo: ProviderInfo object with which to create the new 
    167         change request record 
     167        provider info record 
    168168        @raise ValueError if provider with same name already exists 
    169169        @return ProviderInfo, fileName: object with any new data from the creation in + filename 
    170170        ''' 
    171171        self.pic, fileName = self.__getProviderInfoData() 
    172         logging.info("Creating new provider info in file, '%s'" %fileName) 
     172        logging.debug("Creating new provider info in file, '%s'" %fileName) 
    173173         
    174174        # check provider with the same name doesn't already exist 
     
    183183        self.pic = self.__createOrUpdatePICollection(self.pic) 
    184184         
    185         logging.info("New provider info created in XML file") 
     185        logging.debug("New provider info created in XML file") 
    186186        return providerInfo, fileName 
    187187     
     
    194194        @return ProviderInfo, fileName: object with any new data from the creation in 
    195195        ''' 
    196         logging.info("Updating provider info in XML file") 
     196        logging.debug("Updating provider info in XML file") 
    197197 
    198198        if not providerInfo.name: 
     
    204204        self.pic = self.__createOrUpdatePICollection(self.pic) 
    205205 
    206         logging.info("Change request updated in file") 
     206        logging.debug("Provider info updated in file") 
    207207        return providerInfo 
    208208 
     
    214214        @return True if successful, False otherwise 
    215215        ''' 
    216         logging.info("Deleting provider info in provider info collection") 
     216        logging.debug("Deleting provider info in provider info collection") 
    217217        self.pic, fileName = self.__getProviderInfoData() 
    218218         
    219219        self.pic.removeProviderInfo(providerName) 
    220220        self.pic = self.__createOrUpdatePICollection(self.pic) 
    221         logging.info("Delete complete successfully") 
     221        logging.debug("Delete complete successfully") 
    222222        return True 
    223223 
     
    229229        @return ProviderInfo: object with requested data - or None if no data found 
    230230        '''  
    231         logging.info("Retrieving provider info with name, '%s'" %(providerInfoName)) 
     231        logging.debug("Retrieving provider info with name, '%s'" %(providerInfoName)) 
    232232        pi = None 
    233233        self.pic, fileName = self.__getProviderInfoData() 
     
    235235        try: 
    236236            pi = self.pic.getProviderInfoByName(providerInfoName) 
    237             logging.info("- returning provider info details") 
     237            logging.debug("- returning provider info details") 
    238238        except ValueError: 
    239             logging.info("- no data found with specified name - returning None") 
     239            logging.debug("- no data found with specified name - returning None") 
    240240             
    241241        return pi 
     
    247247        @return ProviderInfo list: list of ProviderInfo objects representing all provider info data 
    248248        '''  
    249         logging.info("Retrieving all provider info data") 
     249        logging.debug("Retrieving all provider info data") 
    250250        self.pic, fileName = self.__getProviderInfoData() 
    251251             
     
    268268            pi = self.pic.getProviderInfoByName(providerInfoName) 
    269269            ri = pi.getRepositoryInfoByName(repositoryInfoName) 
    270             logging.info("- returning repository info details") 
     270            logging.debug("- returning repository info details") 
    271271        except ValueError: 
    272             logging.info("- no data found with specified name - returning None") 
     272            logging.debug("- no data found with specified name - returning None") 
    273273        return ri 
    274274 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/dal/interfaceeditordbclient.py

    r5240 r5242  
    1010    def createProviderInfo(self, providerInfo): 
    1111        ''' 
    12         Create a new change request in DB 
     12        Create new provider info data 
    1313        @param providerInfo: ProviderInfo object with which to create the new 
    1414        provider info record 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/dal/providerinfodao.py

    r5240 r5242  
    4949        Constructor - initialise the DAO with a suitable data access client 
    5050        @param client: DB client to use with DAO - must implement 
    51         vocabtermeditor.dal.InterfaceEditorDataClient interface 
     51        oai_info_editor.dal.InterfaceEditorDataClient interface 
    5252        ''' 
    5353        logging.debug("Initialising ProviderInfoDAO object") 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/editor.config

    r5239 r5242  
    11# 
    2 # Vocab Term Editor Configuration File 
     2# OAI Info Editor Configuration File 
    33# - see toplevel README.txt file for config instructions 
    44# 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/model/providerinfo.py

    r5238 r5242  
    11''' 
    2  Class representing a change request for vocab term data 
    3  - effectively gathering a collection of Vocab Terms together with 
    4  change dates to show the evolution of a new name submission or change request 
     2 Class representing provider info data 
     3 - effectively gathering a collection of RepositoryInfos together with name 
     4 information to group them 
    55   
    6  @author: C Byrom, Tessella Feb 2009 
     6 @author: C Byrom, Tessella Apr 2009 
    77''' 
    88from xml.etree import cElementTree as ET 
     
    3838        ''' 
    3939        Constructor - initialise the ProviderInfo name object 
    40         @keyword et: elementtree entry representing a ProviderInfo - to 
    41         start the change request with 
     40        @keyword et: elementtree entry representing a ProviderInfo object 
    4241        ''' 
    4342        logging.debug("Initialising new ProviderInfo document object") 
     
    6766        ''' 
    6867        Extract data from an elementtree object and add to ProviderInfo object 
    69         - NB, assume if we're doing this, we're reading in a master doc - so we 
    70         don't need to worry about change request - i.e. we start the list of  
    71         standard names from scratch 
    7268         
    7369        @param et: Elementtree object representing a ProviderInfo 
     
    9288    def toET(self): 
    9389        ''' 
    94         Create an array of Elementtree Elements representing the data held by the change request 
    95         object.  NB, order the elements of this according to their creation date 
     90        Create an Elementtree object representing the data held by the provider info 
     91        object. 
    9692         
    9793        @return Elementree representing the ProviderInfo data 
     
    141137        @param repositoryInfo: a RepositoryInfo to remove from the collection 
    142138        ''' 
    143         logging.debug("Removing change request, '%s', from collection" %repositoryInfo) 
     139        logging.debug("Removing repository info, '%s', from collection" %repositoryInfo) 
    144140 
    145141        ris = [] 
     
    152148 
    153149        self.repositoryInfos = ris 
    154         logging.debug("- provider info removed") 
     150        logging.debug("- repository info removed") 
    155151 
    156152 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/model/providerinfocollection.py

    r5238 r5242  
    129129        ''' 
    130130        Add provider info to the collection; if this already exists in the  
    131         collection, replace the old request with the new one 
     131        collection, replace the old object with the new one 
    132132        @param providerInfo: a ProviderInfo to add to the collection 
    133133        @keyword raiseErrorIfNotFound: if True raise a ValueError if the input 
    134134        data is not found 
    135135        ''' 
    136         logging.debug("Adding change request, '%s', to collection" %providerInfo) 
     136        logging.debug("Adding provider info, '%s', to collection" %providerInfo) 
    137137        pis = [] 
    138138        isNew = True 
     
    162162    def removeProviderInfo(self, providerName): 
    163163        ''' 
    164         Remove a change request from the collection 
     164        Remove a provider info record from the collection 
    165165        @param providerName: Name of provider to delete 
    166166        ''' 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/public/layout/style/oai_editor_style.css

    r5226 r5242  
    353353div.hidden {display:none;background-color: #f4f4f4; border:1px solid black;} 
    354354 
    355 #generalRecordTable 
    356 { 
    357         background-color: lightgray;  
    358         border:1px solid black; 
    359 } 
    360  
    361 .vocabTermTable 
    362 { 
    363         background-color: lightgray;  
    364         border:1px solid black; 
    365 } 
    366  
    367355.providerInfoTable 
    368356{ 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/templates/layout.html

    r5237 r5242  
    3434                        <tr><td align="left"> 
    3535                            <a py:if="c.title != EDITOR_HOME_TITLE" href="${h.url_for('home')}">Home</a> 
    36                             <span py:if="c.vocabHomeURL" py:strip=""> 
    37                             <a href="$c.vocabHomeURL">Vocab List Home</a> 
    38                             </span> 
    3936                            </td><td align="right"><a py:if="c.title != HELP_PAGE_TITLE" href="${h.url_for('help')}">Help</a> 
    4037                            </td></tr> 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/templates/oai_info_editor_help.html

    r5226 r5242  
    1717                    <ol> 
    1818                        <li><a href="#intro">Introduction</a></li> 
    19                         <li><a href="#home">Application home page</a></li> 
    20                         <li><a href="#listhome">Vocab list home page</a></li> 
    21                         <li><a href="#changerequests">Creating/updating change requests [editors only]</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> 
    2225                    </ol> 
    2326                    </div> 
    2427                    <a name="intro"><h2>Introduction</h2></a> 
    2528                                <div class="headingblock">                   
    26                     <p> 
    27                     This web application allows the creation and update of vocabulary terms hosted by a 
    28                     vocabulary server.  This is done by creating a 'change request', typically following a 
    29                     discussion on the newsgroup for the associated vocab list.  The request then evolves as 
    30                     discussion continues, e.g. passing through statuses of 'New' to 'Under discussion', before 
    31                     finally being submitted; at this point the vocab servers are contact to update their lists 
    32                     appropriately. 
    33                     <br/><br/> 
    34                     Additional functionality is provided to allow request update details to be mailed to 
    35                     vocab list newsgroups, to view existing lists and to do global updates of data. 
    36                     <br/><br/> 
    37                     NB, the application runs in two modes of operation, depending on the user access rights: 
    38                     Edit mode and View mode. 
    39                     </p> 
     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> 
    4039                                </div> 
    41                     <a name="home"><h2>Application home page</h2></a> 
     40                    <a name="home"><h2>Home page</h2></a> 
    4241                                <div class="headingblock">                   
    4342                    <p> 
    4443                    The home page is available <a href="${h.url_for('home')}"> 
    45                     here</a>; this provides links to the home pages for the different 
    46                     vocab lists available to the application.  These 'vocab list' home pages are 
    47                     described in the next <a href="#listhome">section</a>. 
    48                     <p>To adjust which vocab lists are available to edit/update, 
    49                     add configuration details in the vocabData.config file - as described in the README.txt 
    50                     file in the toplevel directory of the project. 
    51                     </p> 
    52                     </p> 
    53                     </div> 
    54  
    55                     <a name="listhome"><h2>Vocab list home page</h2></a> 
    56                                 <div class="headingblock">                   
    57                     <p> 
    58                     Each vocab list available to the application has its own home page, providing 
    59                     functionality specifically for that vocab list.  The following links are available, 
    60                     depending on the current user access level (as indicated by the square brackets, below): 
     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> 
     54 
     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: 
    6161                    <dl> 
    62                     <dt><b>View vocab list</b></dt> 
    63                     <dd> 
    64                     Displays the current vocab list data, extracted direct from the vocab server. 
    65                     <br/> 
    66                     If the user has 'Edit' access rights, terms can be selected from this list to be 
    67                     'edited' - i.e. a change request is created for the selected term.  Additionally, 
    68                     a link to create new terms (i.e. create a change request for a new term) will be 
    69                     available to editors on this page. 
    70                     </dd> 
    71                     <dt><b>View master doc [CF Standard Names only]</b></dt> 
    72                     <dd> 
    73                     The CF Standard Names vocab data is stored in two places at present.  This link 
    74                     will show the data from the 'master' doc, hosted by the Lawrence Livermore Labs.  NB, 
    75                     this doc includes additional data not included in the vocab server list: 'Units', 'AMIB' 
    76                     and 'GRIB'. 
    77                     </dd> 
    78                     <dt><b>Request new vocab term for list [editors only]</b></dt> 
    79                     <dd> 
    80                     If the current user has 'edit' access rights, they can request a new term 
    81                     by creating a change request.  Details on change requests are available  
    82                     in the <a href="#changerequests">creating/updating change requests</a> section. 
    83                     </dd> 
    84                     <dt><b>Request new global data [editors only]</b></dt> 
    85                     <dd> 
    86                     If the current user has 'edit' access rights, they can request new global 
    87                     data by creating a change request - see  
    88                     <a href="#changerequests">creating/updating change requests</a> section.   
    89                     <br/>NB, creating new 'global' data doesn't actually create any new data on a vocab 
    90                     server; instead the purpose is to facilitate and track discussions of new 
    91                     term details or key phrases to use.  
    92                     </dd> 
    93                     <dt><b>Request change to existing global data [editors only]</b></dt> 
    94                     <dd> 
    95                     If the current user has 'edit' access rights, they can request a change to global 
    96                     data by creating a change request - see  
    97                     <a href="#changerequests">creating/updating change requests</a> section. 
    98                     <br/>If the request is completed successfully, a 'search and replace' operation 
    99                     will be completed across the following two sets of data: 
     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> 
     79 
     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: 
     86                     
     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>Repository Name</b></dt> 
     92                            <dd> 
     93                            the name for the repository [mandatory] 
     94                            </dd> 
     95                                        <dt><b>Base URL</b></dt> 
     96                                        <dd> 
     97                                        the OAI provider URL representing the repository [mandatory] 
     98                                        </dd> 
     99                                        <dt><b>SetSpec</b></dt> 
     100                                        <dd> 
     101                                        an identifier for a subgroup of metadata files in the OAI provider 
     102                                        </dd> 
     103                                        <dt><b>Format</b></dt> 
     104                                        <dd> 
     105                                        the metadata format 
     106                                        </dd> 
     107                                        <dt><b>Split by set</b></dt> 
     108                                        <dd> 
     109                                        if a setspec identifier has been set, if this checkbox is ticked, the 
     110                                        harvested records will be placed in a subdirectory on the harvester 
     111                                        system 
     112                                        </dd> 
     113                                </dl> 
     114                                </p> 
     115                                <p> 
     116                                Additionally, a link 'Add new repository data' is available; if clicked 
     117                                a new row is exposed to input additional repository information.  If several 
     118                                repositories need to be defined, add these one at a time, clicking 'Update' 
     119                                inbetween additions. 
     120                                </p> 
     121                                <p> 
     122                                To save changes, click 'Update'.  The application will then returned to the 
     123                                provider info page. 
     124                                </p> 
     125                    </div> 
     126 
     127 
     128                    <a name="providerinfo"><h2>Creating/editing/deleting provider info</h2></a> 
     129                                <div class="headingblock">                   
     130                    <p> 
     131                    The following functions are available with the application: 
     132                    <dl> 
     133                    <dt> 
     134                    <b>Create Provider Info</b> [admin users only] 
     135                    </dt> 
     136                    <dd> 
     137                    On either the home page or the provider info page, click the 'Create new provider info' 
     138                    link to create a new provider info record.  Having added the data, click 'Update'.  Control 
     139                    will return to the home page - and a new link will be visible to the newly 
     140                    added provider data 
     141                    </dd> 
     142                    <dt> 
     143                    <b>Edit Provider Info</b> 
     144                    </dt> 
     145                    <dd> 
     146                    On the provider info page, click the 'Edit' link next to a particular 
     147                    provider info record.  The provider info edit page will then open and 
     148                    the associated data can be adjusted as required. 
     149                    </dd> 
     150                    <dt> 
     151                    <b>Delete Provider Info</b> [admin users only] 
     152                    </dt> 
     153                    <dd> 
     154                    On the provider info page, click the 'Delete' link next to a particular 
     155                    provider info record.  A confirmation dialogue will appear to ensure 
     156                    that the deletion is actually desired.  If this is confirmed, the  
     157                    provider info will then be deleted open and 
     158                    control will return to the application home page.  A pop up message will 
     159                    indicate the outcome of the delete. 
     160                    </dd> 
     161                    </dl> 
     162                    </p> 
     163                    </div> 
     164 
     165                    <a name="repositoryinfo"><h2>Creating/editing/deleting repository info</h2></a> 
     166                                <div class="headingblock">                   
     167                    <p> 
     168                    On the provider info page, click the 'Edit' link next to a particular 
     169                    provider info record.  The provider info edit page will then open and 
     170                    the associated data can be adjusted as required.  New repository data 
     171                    can be added by clicking the 'Add new repository data' link.  When the 
     172                    data is as required, click 'Update' to save it to the system.  To delete 
     173                    a repository info record, just delete all its associated text and click 
     174                    'Update'. 
     175                    </p> 
     176                    </div> 
     177 
     178                    <a name="harvest"><h2>Harvesting data</h2></a> 
     179                                <div class="headingblock">                   
     180                    <p> 
     181                    On the provider info page, click the 'Harvest' button next to a particular 
     182                    provider info record.  A harvest will then be undertaken.  Note this is a 
     183                    two stage process: 
    100184                    <ol> 
    101                         <li>the vocab list data; any terms that are affected by the search/replace 
    102                         will be updated on the vocab server automatically (also applies to the 'master 
    103                         doc' for the CF Standard Names list)</li> 
    104                         <li>the parser data used to generate standard definitions from the 
    105                         vocab term names</li> 
     185                    <li> 
     186                    The metadata (or specified subset of) exposed by the OAI provider is harvested 
     187                    to the BADC system.  
     188                    </li> 
     189                    <li> 
     190                    If the harvest completes successfully, the harvested documents are then 
     191                    ingested into the BADC Discovery Service. 
     192                    </li> 
    106193                    </ol> 
    107                     Note, for the vocab list data, the search/replace is only done on the exact  
    108                     matching info - e.g. if the definition field has changed, only the 
    109                     vocab term definitions will be affected by the change.  For the parser 
    110                     data, however, all changes will be applied, regardless of their context -  
    111                     since this doesn't relate to this data.   
    112                     </dd> 
    113                     <dt><b>View status of current work</b></dt> 
    114                     <dd> 
    115                     View the change requests for the current vocab list which are not in the 
    116                     'Completed' or 'Rejected' state. 
    117                     <dl> 
    118                         <dt><b>[editors only]</b></dt> 
    119                         <dd> 
    120                                 Use the 'Edit' link alongside the change requests displayed, to  
    121                                 update their details.<br/> 
    122                                 Use the 'Request new vocab term for list' link to create a  
    123                                 change request for new term data.<br/> 
    124                                 Use the 'Mail updates' link to mail the details of the associated  
    125                                 change request to the vocab list mailing list.<br/> 
    126                                 Combine several change request details into a single mail to the 
    127                                 vocab list mailing list by selecting their checkboxes and 
    128                                 then clicking the 'Mail checked updates together' button.<br/> 
    129                                 Submit several change requests simultaneously by selecting their  
    130                                 checkboxes and clicking the 'Submit checked requests together' button. 
    131                         </dd> 
    132                     </dl> 
    133                     </dd> 
    134                     <dt><b>View completed work</b></dt> 
    135                     <dd> 
    136                     View the change requests for the current vocab list which are in the 
    137                     'Completed' or 'Rejected' state. 
    138                     </dd> 
    139                     </dl> 
    140                     </p> 
    141                     </div> 
    142                      
    143                     <a name="changerequests"><h2>Creating/updating change requests [editors only]</h2></a> 
    144                                 <div class="headingblock">                   
    145                     <p> 
    146                     If the user has edit access and they click on a link to either create new 
    147                     data or edit existing data, they will be taken to a 'change request edit' 
    148                     page.  This has a number of inputs, detailed here: 
    149                     <dl> 
    150                             <dt><b>Created Date</b></dt><dd> 
    151                             the creation data of the current change request; NB, this is non editable and is set automatically. 
    152                             </dd> 
    153                             <dt><b>Status</b></dt> 
    154                             <dd> 
    155                             the status of the change request.  For new requests, this is fixed at 'New', otherwise, the 
    156                             following values are available: 
    157                                 <dl> 
    158                                                 <dt>Under Discussion</dt> 
    159                                         <dd>to be used following the creation of the request, when the data is being reviewed 
    160                                         and discussed by the newsgroup</dd> 
    161                                                 <dt>Accepted</dt> 
    162                                         <dd>to be used once discussions have matured and concensus has been reached</dd> 
    163                                                 <dt>Rejected</dt> 
    164                                         <dd>to be used if the proposed request has been rejected, following discussion;  
    165                                         this will remove the request from the 'View status of current work' page and put 
    166                                         it into the 'View completed work' page.</dd> 
    167                                                 <dt>Submitted</dt> 
    168                                         <dd>following a request being accepted, it should be put into the 'Submitted' state. 
    169                                         This will instigate any associated workflow to complete the request - e.g. updating 
    170                                         the vocab server lists or parser data.  If this workflow completes successfully, the 
    171                                         request state will change automatically to 'Completed'; if a problem occurs on submission, 
    172                                         the request will be returned to the 'Accepted' state.  NB, updating vocab data entails 
    173                                         a time lag, since the server data is only refreshed overnight; whilst a submitted 
    174                                         request is waiting for this process to complete, it will wait in the 'Pending' state.</dd> 
    175                                                 <dt>Pending</dt> 
    176                                         <dd>an intermediate status, which is mainly used by the automated workflow following 
    177                                         the submission of data to vocab servers; whilst this submission is waiting to be 
    178                                         completed, the request will remain in the 'Pending' state.  NB, requests in this 
    179                                         state will be periodically checked to see if their data has actually been updated on the 
    180                                         vocab server; if so, they are then moved to the 'Completed' state.</dd> 
    181                                                 <dt>Completed</dt> 
    182                                         <dd>the final status of a request that has completed successfully.  This should 
    183                                         largely be set automatically by the workflow instigated by putting the request 
    184                                         into a 'Submitted' state, however it may be useful to shortcircuit this workflow 
    185                                         in some cases (e.g. dealing with exceptional cases which the web app cannot  
    186                                         reliably process).</dd> 
    187                                 </dl> 
    188                                         </dd> 
    189                                         <dt><b>Proposer</b></dt> 
    190                                         <dd> 
    191                                         </dd> 
    192                                         <dt><b>Proposed Date</b></dt> 
    193                                         <dd> 
    194                                         </dd> 
    195                                         <dt><b>Comment</b></dt> 
    196                                         <dd> 
    197                                         </dd> 
    198                                         <dt><b>Mailing List Thread</b></dt> 
    199                                         <dd> 
    200                                         </dd> 
    201                                         <dt><b>Mailing List Thread URL</b></dt> 
    202                                         <dd> 
    203                                         </dd> 
    204                                 </dl> 
    205                                 Below the 'header' information for the change request is a separate 
    206                                 section to enter the actual vocab term data to create/update.  Depending 
    207                                 on the context, this will have a link to either 'Add data' or 'Change data'; 
    208                                 clicking on this link will allow the input of the following information: 
    209                                 <dl> 
    210                                         <dt><b>Change Date</b></dt> 
    211                                         <dd> 
    212                                         A non-editable field giving the date of the current change. 
    213                                         </dd> 
    214                                         <dt><b>External ID</b></dt> 
    215                                         <dd> 
    216                                         the external id of the vocab term; NB, this is partly generated 
    217                                         by the vocab server*** 
    218                                         </dd> 
    219                                         <dt><b>Preferred Label</b></dt> 
    220                                         <dd> 
    221                                         the main label for the vocab term 
    222                                         </dd> 
    223                                         <dt><b>Alternative Label</b></dt> 
    224                                         <dd> 
    225                                         an alternative label for the vocab term 
    226                                         </dd> 
    227                                         <dt><b>Definition</b></dt> 
    228                                         <dd> 
    229                                         a definition of the vocab term 
    230                                         </dd> 
    231                                 </dl> 
    232                                 NB, for vocab data for the CF Standard Names list, this data is slightly 
    233                                 different: 
    234                                 <dl> 
    235                                         <dt><b>Change Date</b></dt> 
    236                                         <dd> 
    237                                         A non-editable field giving the date of the current change. 
    238                                         </dd> 
    239                                         <dt><b>CF Standard Name</b></dt> 
    240                                         <dd> 
    241                                         the name of the vocab term 
    242                                         </dd> 
    243                                         <dt><b>Description</b></dt> 
    244                                         <dd> 
    245                                         a description of the vocab term 
    246                                         </dd> 
    247                                         <dt><b>Units</b></dt> 
    248                                         <dd> 
    249                                         the units associated with the vocab term 
    250                                         </dd> 
    251                                         <dt><b>AMIP</b></dt> 
    252                                         <dd> 
    253                                         </dd> 
    254                                         <dt><b>GRIB</b></dt> 
    255                                         <dd> 
    256                                         </dd> 
    257                                 </dl> 
    258                     </p> 
    259                     </div> 
    260                      
     194                    </p> 
     195                    <p> 
     196                    The outcome of both of these operations, together with basic details (e.g. 
     197                    number of records harvested) is then displayed to the user. 
     198                    </p> 
     199                    <p> 
     200                    Note, although users can request harvests manually, these will also 
     201                    happen automatically, on a daily basis, by the BADC harvester. 
     202                    </p> 
     203                    </div> 
    261204                </div> 
    262205        </div> 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/templates/provider_info.html

    r5239 r5242  
    1 <!--! Template methods to support Change Request data --> 
     1<!--! Template methods to support Provider Info data --> 
    22<html xmlns="http://www.w3.org/1999/xhtml"  
    33        xmlns:py="http://genshi.edgewall.org/" 
     
    5858                <td /> 
    5959                <th>Repository Info</th> 
    60                 <td colspan="$colSpan"> 
     60                <td> 
    6161                <div py:replace="RepositoryInfoTable(record.repositoryInfos, isEditable, editLink, harvestLink.replace(constants.PROVIDER_REPLACEMENT, urllib.quote(record.name)))" /> 
    6262                </td> 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/templates/repository_info.html

    r5239 r5242  
    1 <!--! An individual record - representing something to create/update --> 
     1<!--! Template methods to support Repository Info data --> 
    22<html xmlns="http://www.w3.org/1999/xhtml"  
    33        xmlns:py="http://genshi.edgewall.org/" 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/templates/utils.html

    r5226 r5242  
    11<?python  
    2         import vocabtermeditor.lib.constants as constants 
    3         from vocabtermeditor.lib.utilities import htmlifyLineBreaks 
     2        import oai_info_editor.lib.constants as constants 
    43?> 
    54<html xmlns="http://www.w3.org/1999/xhtml" xmlns:py="http://genshi.edgewall.org/" 
     
    7271                </td> 
    7372                <td py:if="not isEditable" class="column" width="$width" colspan="$colspan"> 
    74                         ${Markup(htmlifyLineBreaks(value))} 
     73                        ${Markup(value)} 
    7574                </td> 
    7675        </div> 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/tests/model/testproviderinfocollection.py

    r5238 r5242  
    8686        self.assertEquals(1, len(self.pic.providerInfos)) 
    8787 
    88     def OFFtestAddProviderInfoUpdate(self): 
    89         self.pic.setData(STANDARD_NAMES_LIST, [CHANGE_REQUEST_WITH_VOCAB_TERM_DATA]) 
    90         # NB, this is identical to CHANGE_REQUEST_WITH_VOCAB_TERM_DATA but with 
    91         # a new comment 
    92         updatedCR = createProviderInfoWithData(FIXED_DATE_VOCAB_TERM_DATA,STANDARD_NAMES_LIST, 
    93                                                 VALID_PROPOSED_DATE, VALID_PROPOSED_BY,  
    94                                                 VALID_CHANGE_TYPE, VALID_COMMENT_2,  
    95                                                 VALID_THREAD_TITLE, VALID_THREAD_URL, 
    96                                                 VALID_STATUS, createdDate = VALID_CREATED_DATE, 
    97                                                 dbID=VALID_CH_VOCAB_DATA_ID) 
    98         self.pic.addProviderInfo(updatedCR) 
    99         self.assertEquals('1', self.pic.version) 
    100         self.assertEquals(1, len(self.pic.providerInfos)) 
    101         self.assertEquals(VALID_COMMENT_2, self.pic.providerInfos[0].comment) 
    102  
    10388 
    10489    def testRemoveProviderInfo(self): 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/tests/testdata/editor.config

    r5226 r5242  
    11# 
    2 # Vocab Term Editor Configuration File 
     2# OAI Info Editor Configuration File 
    33# - see toplevel README.txt file for config instructions 
    44# 
  • TI01-discovery/trunk/OAIInfoEditor/oai_info_editor/tests/testdata/invalid_editor.config

    r5226 r5242  
    11# 
    2 # Invalid test Vocab Term Editor Configuration File 
     2# Invalid test OAI Info Editor Configuration File 
    33# 
    44[SERVERS] 
Note: See TracChangeset for help on using the changeset viewer.