Norfolk Portal Search Facility Technical Manual for Team Managers by variablepitch349

VIEWS: 0 PAGES: 28

									PROJECT DOCUMENTATION

Norfolk Portal Search Facility Technical Manual for Team Managers

Norfolk Connect Project 2003/04

Release: Draft Date: 21/04/04 PRINCE 2 Author: Andrew Mewes Owner: Norfolk Connect Partnership Project Office Client: Norfolk Connect Partnership Document Number: 0.1

Norfolk Connect Partnership – Portal Technical Manual

This document has been produced for NCP Team Managers to provide a reference guide to the Norfolk Connect Portal search engine facility and was produced following the training given by Open Objects to Team Managers in October 2003 and the ongoing development of Portal enhancements.

Contents
1. 2. 3. OVERVIEW..................................................................................................................................3 THE “VIRTUAL PORTAL” ARCHITECTURE......................................................................3 THE INDEX “COLLECTIONS” ................................................................................................4 3.1. A “WITHIN COUNCIL” SEARCH ....................................................................................................4 3.2. AN “ALL NORFOLK” SEARCH ......................................................................................................5 3.3. EXCLUDING CONTENT FROM BEING INDEXED ..............................................................................5 4. FACTORS THAT INFLUENCE RANKING OF SEARCH RESULTS .................................6 4.1. WHICH METADATA ITEMS INFLUENCE RANKING? .......................................................................6 4.2. CASE SENSITIVITY WHEN SEARCHING .........................................................................................7 5. 6. 7. 8. 9. SEARCH RESULTS "TABS" (SITES.XML FILE) .................................................................8 RECOMMENDED LINKS (“QUESTIONS.XML”) ...............................................................10 TIDYING SEARCH RESULTS SUMMARIES (STOP/START TAGS) ..............................12 THE PORTAL SEARCH SPELLCHECKER & THESAURUS............................................13 EMBEDDING THE PORTAL SEARCH FACILITY INTO YOUR WEBSITE .................14 9.1. ADVANCED EMBEDDING OF THE SEARCH FACILITY INTO YOU WEBSITE ...................................15 9.2. LINKING TO THE SEARCH FACILITY FROM YOUR WEBSITE .........................................................17 10. JOINT A-Z LISTING OF SERVICES .....................................................................................18 THE URLS FOR CALLING A JOINT A-Z LISTING ....................................................................20 JOINT A-Z SEARCH FACILITY ................................................................................................22 10.1. 10.2. 11. 12.

GEO-REFERENCED SEARCHING........................................................................................24 OTHER DOCUMENTS AVAILABLE.....................................................................................25
Appendices............................................................................................................................................. 26 A. Key Open Objects URLs for each Partner ..................................................................................... 27 B. Sopra Action Request form ........................................................................................................... 28

Norfolk Connect Partnership – Portal Technical Manual

1. Overview
The purpose of this document is to provide an overview of the Portal facilities for the Partnership Team Managers and to provide in a single document information about portal configuration and functionality. The Norfolk Connect Portal is a “Virtual Portal” that is hosted at Open Objects' site in Cambridge (UK) and provides a centralised search facility across Partner web sites. The Partnership undertook an OJEC open procurement in 2003 in order to identify a supplier for the Portal. The procurement was won by the Sopra Group who provide Consultancy and Integration services and who sub-contract the portal service to Open Objects. Following Acceptance Testing by the Partnership, Phase 1 of the Portal went live on 24 November 2003 and established the underlying search capability, indexes and style sheets. Partners then linked the search into their own web sites (ie, embedding the Portal search field on their web pages or having a hyperlink to the Open Objects site). In parallel to this Sopra and Open Objects have been working on enhanced functionality (Portal Phase 2) for the Portal to allow joint A-Z listings of Council services to be produced and searches to be made by geographic references (eg, postcode, location etc).

2. The “Virtual Portal” Architecture
A key architectural design principle agreed by the Partners was that each Partner should be able to maintain their web site content on systems of their own choosing rather than be forced into publishing their information to a central server or to a single hosting supplier. The latter had been tried in the past but was found to be unsustainable over time as Partners chose to move to alternative hosting solutions for reasons of convenience and efficiency. Instead of a centrally hosted "Portal", the architecture chosen for the Partnership was a "Virtual Portal" utilising a search engine to centrally index content residing on the Partners' own individual websites. The Norfolk Connect "Portal" uses Inktomi Ultraseek search engine software as used by a number of high profile public sector organisations including, UKOnline, Inland Revenue and Home Office. The Portal regularly “spiders” each Partners’ web sites and forms an index of their content (this index resides on the Open Objects servers). An end-user performs a textual search against the index and the Portal returns a list of matching results. The results are displayed on a web page held on the Open Objects server but the web page uses a style sheet provided by each Partner so that the page looks like that of the Partner's own web site. The list of results from a search contain clickable hyperlinks which when selected by an end-user will direct the browser to the relevant web site and display the content that was found in the search results. The search engine servers are situated behind an Internet connected firewall at Open Objects. There are two physical servers that store the index and a load balancer is used to distribute end-users’ search requests between the two servers. Spidering of Partner web sites is done (at present), once a day by one of the servers and then the index is replicated to the other server.

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 3 of 28

Norfolk Connect Partnership – Portal Technical Manual

Reindexing of pages can be done for an individual Partner's site/s or all the indexed sites. The frequency of reindexing is controlled by Open Objects, the maximum revisit of the spider to a web page can be set at 5 days and the minimum can be set at 1 day. Partners can request Open Objects to force a reindex of their site (eg, if they have redesigned their site) via the Sopra Action Request form (shown in Appendix B). Note: The Portal will spider and index all pages belonging to a particular web address. However, it will not automatically spider/index across to another website that is linked from this web address. Eg, if www.norfolk.gov.uk is being spidered/indexed and contains a link to another website address (eg, www.anothersite.com or even www2.norfolk.gov.uk), the other address will not be indexed. Open Objects will not spider/index a site without prior agreement/request from an NCP Partner.

3. The Index “Collections”
When a search is performed, the user has the option to specify whether they want to search all content spidered by the Portal (an "All Norfolk" search) or just content belonging to the indexed "collection" of a Partner. Depending on what the user decides will depend on the content in the index that is being searched. The following tables show the current sites (as at 14 April 2004) that are being indexed and whether they appear under a Partner's index collection ie, are searchable from a Partner's site, or only from an "All Norfolk" search:

3.1.

A “within council” search

A search performed on a Partners' website will only search content "within" that Council plus any other sites that form their index "collection". This is shown in the table below (correct as at 14 April 2004):
A search of just this Partner's "collection"... Breckland District Council Broadland District Council Great Yarmouth Borough Council Kings Lynn & West Norfolk Borough Council North Norfolk Council Norfolk County Council ...will result in searching ...finding content indexed from content from this/these this/these website addresses websites... Breckland District Council www.breckland.gov.uk Broadland District Council www.broadland.gov.uk Great Yarmouth Borough Council www.great-yarmouth.gov.uk Kings Lynn & West Norfolk Borough Council North Norfolk Council Norfolk County Council Norfolk Fire Service Norfolk Ambition Esinet for Learning Norfolk :Time to explore Norfolk Data Observatory Super Shaping the Future Passenger Transport Unit Norwich City Council South Norfolk District Council www.west-norfolk.gov.uk www.northnorfolk.org www.norfolk.gov.uk www.norfolkfireservice.gov.uk www.norfolkambition.gov.uk www.norfolkesinet.org.uk www.visitnorfolk.co.uk www.norfolkdata.net www.superuk.com www.shaping-the-future.org www.passengertransport.norfolk.gov.uk www.norwich.gov.uk www.south-norfolk.gov.uk

Norwich City Council (*) South Norfolk District Council

(*) At time of writing due to an imminent website redesign, Norwich City have not embedded the Norfolk Portal search facility into their existing website - its content is

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 4 of 28

Norfolk Connect Partnership – Portal Technical Manual

however being indexed and would be searched when doing an "All Norfolk" search from any of the other Partners' websites.

3.2.

An “All Norfolk” search

An "All Norfolk" search will search on content from all websites above but also the content of other organisations that have been indexed. the following is a list of the other organisations' websites that have been indexed (as at 14 April 2004):
An "All Norfolk" search from one of the Partners' websites will result in searching content from these additional websites Norfolk Police Broads Authority Wayland Partnership Development Trust YouthZone West Norfolk Partnership The Corn Exchange, King's Lynn King's Lynn Arts Centre Princess Theatre, Hunstanton Discovery Beatbox Heron - Local health information for Norfolk Norfolk & Norwich Voluntary Services The Rural Transport Partnership Address of website www.norfolk.police.uk www.broads-authority.gov.uk www.wayland.org.uk www.youthzone.biz www.wnp.org.uk www.kingslynncornexchange.co.uk www.kingslynnarts.co.uk www.princesstheatrehunstanton.co.uk www.discoverybeatbox.co.uk www.nhs.norfolk.nhs.uk www.nvs.org.uk www.rural-transport.com

Other organisations are invited to join the Portal (ie, have their websites indexed by the Portal Search facility) via the Engagement Pack and application form on the Norfolk Connect website (www.norfolkconnect.gov.uk).

3.3.

Excluding content from being indexed

A Partner can ask Open Objects not to index certain content on their website if they do not want it to appear in any search results. For example, some Partners whose websites are hosted by Tagish have asked Open Objects not to index content in "/text" and "/leadpages" directories because these directories contain duplicate content and so produce duplicate search results if included in the search index. Similarly, other Partners using ASP pages on their websites together with HTML printer-friendly versions of the same pages, have asked Open Objects to filter-out the HTML pages (*htm*) from their index so as not to have duplicate content appearing in the search results.

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 5 of 28

Norfolk Connect Partnership – Portal Technical Manual

4. Factors that influence ranking of Search Results
(The following material was provided by Gavin Cameron, Open Objects, on 14/11/03).

4.1.

Which metadata items influence ranking?

The table below shows the current mapping between metanames found in documents and the fieldnames in the index. For example, for the date field any of the listed metadata items may be mapped to this field. The mapping is a process of discovery – as a document is indexed the search engine will look for the listed metadata items within that document, if it finds one of them then the value of this metadata item is mapped to the date field in the index. If more than one of the tags is present, then the first matching tag in the list (in table order from left to right) is the tag that is mapped to the index field. If none of the tags are found then the search engine has a default action to populate the field (default shown in italics for each field). Index Fieldname Title field (default uses the contents of <title> tag for HTML documents) Date field (default uses the date modified offered by the web server when fetching the document) Description field (default uses first 255 bytes of text in the document) Keywords field (default generates some keywords from the title and text of the document) Metaname dc.title

eGMS.Date.Issued,dc.date.modified,date,dc.date

description,dc.description

eGMS.Subject.keywords,keywords,dc.subject

All of the above is configurable, so extra tags may be added to the field mappings. The set of tags above has so far proved to be the right set for the Norfolk Connect portal. Having mapped the tags to index fields, there are settings in the search engine which allow us to set the relative importance attached to each of the fields when calculating relevance. The current setting on Norfolk Connect are:

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 6 of 28

Norfolk Connect Partnership – Portal Technical Manual

Index field name Title Description Keywords

Indexer weight setting 10 8 4

The weight settings give a measure of the importance attached to finding the search terms in the field relative to finding the search terms in body text of the document. So, if a search term is found in the Title field, then it is considered 10 times more important than an occurrence in the body text. These weighting differentials contribute towards the calculation of document scores, which are the basis for the search engine deciding which in order to display the results. As it stands we have set the title field to the maximum of 10 as this is always a good indicator of the underlying subject of a document (particularly since the improvements made on some of the Norfolk sites with regard to title settings). The keywords are set relatively low at 4 because of the inconsistency of their application across the portal. As the quality of the metadata improves this value could be increased. Whilst all of the above are useful in influencing rankings, it is important to remember that the search engine is creating a full text index, and the biggest influence of all in determining ranking will be the overall language used within the whole document to express the meaning.

4.2.

Case sensitivity when searching

(The following was provided by Richard Fieldsend, Open Objects Support, on 9th January 2004): The default case sensitivity behaviour for searching is as follows: • • All lowercase searches are considered case insensitive, and matches in mixed case are given the same relevance as those that are all lowercase. Searches including uppercase characters are case sensitive. This means improved results if you enter names with an uppercase (such as John Smith).

Open Objects can make all searches case insensitive (they use a servlet to lowercase the search terms), but recommend that we stick with it as it stands. Usually people only uppercase first letters in the case of names or places, (and even then, only when people have an appreciation of grammar!), but in these cases it improves the search quality markedly. With regards to which case to use in metadata for web pages, the best blanket approach is to use lowercase where words would not normally be written with uppercase first letters. So roads, would be written with a lowercase "r", but with uppercase for proper names and other words that would normally use uppercase. This will lead to the metadata matching for lowercase searches, but giving a high relevance when a mixed case is matched in a search.

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 7 of 28

Norfolk Connect Partnership – Portal Technical Manual

5. Search Results "tabs" (sites.xml file)
Partners can have "tabs" set up which sub-divide search results into categories of their choosing. Eg, in the screenshot below, a search on "council tax" shows all the search results under the "All Results" tab. If the user clicks on another tab eg, "South Norfolk Leisure", they will see a subset of the results relating to "council tax" from content categorised under this tab heading.

The tabs are created by Partners submitting a "sites.xml" file to Open Objects. In the file you define the text label you want to see appear in the Tab and your website directory path of where the content is held that relates to the label used. Eg, In the South Norfolk example they have "<label>South Norfolk Leisure</label>" and "<path>/south-norfolk/leisure.nsf</path>". So when a search is performed all matching results are shown under the "All Results" tab and if there are any matching results from content in a directory defined in the sites.xml file, then only these results will be shown when the corresponding Tab is clicked. Below is an example of a sites.xml file for South Norfolk:

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 8 of 28

Norfolk Connect Partnership – Portal Technical Manual

<?xml version="1.0" encoding="ISO-8859-1" ?> <!DOCTYPE kbroker_sites (View Source for full doctype...)> - <kbroker_sites version="2"> - <!-Own Site Entries --> - <!-South Norfolk Sites --> - <entry> <host>www.south-norfolk.gov.uk</host> - <site> <label>South Norfolk Your Council</label> <path>/south-norfolk/council.nsf</path> <quality>1</quality> <rel-link>/</rel-link> </site> - <site> <label>South Norfolk Business</label> <path>/south-norfolk/business.nsf</path> <quality>1</quality> <rel-link>/</rel-link> </site> - <site> <label>South Norfolk A-Z of Services</label> <path>/nwia/az.nsf</path> <quality>1</quality> <rel-link>/</rel-link> </site> - <site> <label>South Norfolk Transport</label> <path>/south-norfolk/transport.nsf</path> <quality>1</quality> <rel-link>/</rel-link> </site> - <site> <label>South Norfolk Tourism</label> <path>/south-norfolk/tourism.nsf</path> <quality>1</quality> <rel-link>/</rel-link> </site> - <site> <label>South Norfolk Leisure</label> <path>/south-norfolk/leisure.nsf</path> <quality>1</quality> <rel-link>/</rel-link> </site> - <site> <label>South Norfolk Press Releases</label> <path>/south-norfolk/news.nsf</path> <quality>1</quality> <rel-link>/</rel-link> </site> </entry> - <!-End of Own Site Entries -->

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 9 of 28

Norfolk Connect Partnership – Portal Technical Manual

6. Recommended Links (“questions.xml”)
Recommended Links are established by a Partner submitting a “questions.xml” file to Open Objects. Open Objects can configure a Recommended Link to appear only on one Partner's site or to be global and appear when searching from any Partner sites. Thus Recommended Links can be used for focussed searches of such things like FAQs or Life Events whether they are specific to one Partner or relevant to them all. On doing a search, if a word or words match that of the Recommended Link “Trigger” word/s then the Recommended Link will be displayed above all the search results. Eg, the screenshot below shows a search for "benefits" which has triggered three Recommended Links:

The questions.xml file entry for the first of the three Recommended links is shown below: - <entry>
<label>How do I report a suspected Benefit Fraud?</label> <summary><summary /> <url>http://www.southnorfolk.gov.uk/nwia/az.nsf/SnkCategories/BA39FC98D7DB58D080 256DCC00396070?OpenDocument&Site=Snk&Display=Snk</url> - <trigger> <primary>benefit</primary> <auxiliary>fraud</auxiliary> <auxiliary>cheat</auxiliary> </trigger> - <trigger> <primary>benefits</primary> </trigger> </entry>

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 10 of 28

Norfolk Connect Partnership – Portal Technical Manual

In the above: • • • The label is the text shown in the Recommended Link. The url is the address displayed when the user clicks on the Recommended Link. The trigger defines the word/s that if used in a search will trigger the Recommended Link to be displayed.

A trigger will have at least one primary and optionally a number of auxiliary words. In the above example, the Recommended link will be displayed if any of the following words are searched for: • • • • benefits benefit benefit fraud benefit cheat

Furthermore the Recommended Link will be displayed if combinations of these words with other words are searched for, eg: • • • • what are benefits what is a benefit why benefit from fraud can you cheat a benefit

Gavin Cameron (Open Objects) reported on 17/3/04 that trigger words can be case sensitive. If you use an uppercase letter in a trigger word then the Recommended Link will only show when an end user uses the same uppercase letter in their word search. However, if you use all lowercase in your trigger words then the Recommended Link will display no matter what case is typed by the end user doing the search. Thus it is suggested that trigger words always be lowercase in questions.xml files.

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 11 of 28

Norfolk Connect Partnership – Portal Technical Manual

7. Tidying search results summaries (stop/start tags)
In the first search result entry shown below on the left, the Youthzone website's menu items are shown in the search results rather than content from their webpage. This is because the Portal is spidering pages and any text it finds (including text in menus or alternative image tags) will be treated as actual content.

To stop the Portal from treating such text as actual content, you can insert stop/start index tags into your pages. This enables you to tell the Portal to stop indexing text but to still traverse down any links to index further content. Thus in the above example on the Youthzone page, before the start of the menus :
GameZone | HealthZone | LearningZone | LeisureZone | LifeZone | WorkZone | GraffitiZone | MailZone

you would insert into the HTML for the page the Stop tag: <!--stopindex-->

and at the end of the menus you would insert the start tag:
<!--startindex-->

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 12 of 28

Norfolk Connect Partnership – Portal Technical Manual

8. The Portal Search Spellchecker & Thesaurus
The Portal has a relatively large dictionary (approx 100,000 words) that it uses to check words entered for searching and may prompt the user with suggested alternative words (as shown below).

Open Objects can add further words to the dictionary upon request and have added Norfolk Parish names into the dictionary. The extent to which an end-user is prompted for a potential misspelling has been set to a medium level by Open Objects as a balance between a) prompting the user too much and b) assuming the word is correctly spelt but not in the dictionary. The Portal also has a Thesaurus capability that Open Objects can set up if required for matching synonyms of terms to related words or phrases.

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 13 of 28

Norfolk Connect Partnership – Portal Technical Manual

9. Embedding the Portal search facility into your website
Partners can embed a Portal search field into their own website as Broadland have done (see bottom left field in screenshot below). When a user does a search from the site, the search word/s are submitted to Open Objects in a URL string and the search results are displayed from the Open Objects site. The results are displayed using the style sheet provided to Open Objects by the Partner so as to keep the look & feel consistent with the Partner's own website.

An example of the HTML code to add to your site to embed the search field is shown below (taken from the Broadland example):
<form name="kbs" method="GET" action="http://search2.openobjects.com/kbroker/ncc/broadland/kbsearch"> <input type="text" name="qt" size="16" maxlength="100" value="" /> <input type="hidden" name="sr" value="0" /> <input type="hidden" name="nh" value="10" /> <input type="hidden" name="cs" value="iso-8859-1" /> <input type="hidden" name="sc" value="broadland" /> <input type="hidden" name="ha" value="135"> <input type="hidden" name="mt" value="0"> <input type="hidden" name="to" value="0" /> <input type="submit" value="Search"> </form>

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 14 of 28

Norfolk Connect Partnership – Portal Technical Manual

The above code when searching from Broadland's website for the word "Norwich" would generate a URL which would be:
http://search2.openobjects.com/kbroker/ncc/broadland/kbsearch?qt=norwich&sr=0&nh=10&cs=iso-8859-1&sc=broadland&ha=135&mt=0&to=0

In order to embed the search field into you own web site, using the example HTML code above, you would substitute your own sub-directory name, handler value (ha) and scope value (sc) using the values shown below: Type of Search Breckland Broadland Great Yarmouth King's Lynn&West Norfolk South Norfolk Norfolk County Council Norwich City North Norfolk All Norfolk Handler Value (ha) 134 135 136 137 138 139 140 141 99 Scope Value (sc) & Subdirectory Name breckland broadland greatyarmouth westnorfolk southnorfolk norfolkcc norwich northnorfolk -

The following provides an overview of the other field values in the URL: Item
qt

value
size="20" maxlength="100" value="Type search phrase here" 0 1 2 1 10 0 10 20

result
Would show a search field of 20 chars wide that accepts a maximum of 100 characters input by the user & displays the words "Type search phrase here" in the field. Would do an "All words" search Would do an "Any words" search Would do an "Exact phrase" search Searches for the word/s in the "Title only" of web content rather than the body of the web page Displays 10 search results per page Displays the first page of 10 results Displays the second page of 10 results Displays the third page of 10 results etc

mt mt mt to nh sr sr sr

9.1.

Advanced Embedding of the Search facility into you website

The North Norfolk website shows an enhancement to just embedding the search field into their site as they have also included the option for the user to do an "All Norfolk" search directly from their site (as shown in the top right of the screen below):

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 15 of 28

Norfolk Connect Partnership – Portal Technical Manual

North Norfolk's HTML code for their embedded search is shown below:

<form name="searchform" action="http://search2.openobjects.com/kbroker/ncc/northnorfolk/kbsearch" method="get" onsubmit="return validateForm(this)" class="navform"> <input class="text" type="text" name="qt" value="SEARCH" id="search" size="15" /> <input id="submit" type="submit" value="GO" class="button" /> <input type="hidden" name="sr" value="0" /> <input type="hidden" name="nh" value="10" /> <input type="hidden" name="cs" value="is0-8859-1" /> <input type="hidden" name="sc" value="northnorfolk" /> <input type="hidden" name="ha" value="141" /> <br /> <input type="checkbox" name="ha" value="99" id="ha" />All Norfolk <a href="http://www.northnorfolk.org/default_norfolkportal.asp" title="Tick this box before selecting 'GO' to search all Norfolk Council and partner websites. Click here for a full explanation."><strong>&nbsp;?&nbsp;</strong></a> <input type="hidden" name="mt" value="0" /> </form>

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 16 of 28

Norfolk Connect Partnership – Portal Technical Manual

9.2.

Linking to the search facility from your website

If you do not embed the search on your site, then your content will only be seen in search results when an end-user does an "All Norfolk" search from one of the other Partners' sites. However, as an alternative to embedding the search field on your site, you could just have a link to your style sheet search page on the Open Objects site. Eg, for Norwich City the URL/link to include on their website to point to their search page on the Open Objects server is: http://search2.openobjects.com/kbroker/ncc/norwich/search.jsp (Other Partners would replace "norwich" in the URL with their own sub-directory name shown in the table above). The above URL displays the current Norwich City style sheet search page (shown below) which resides on the Open Objects server and from this an end-user could do a search of Norwich City's content or an "All Norfolk" search.

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 17 of 28

Norfolk Connect Partnership – Portal Technical Manual

10. Joint A-Z Listing of Services
As defined in the NCP Metadata specification, by using specific metadata on pages intended to describe your Council's services, the Portal can spider these pages and dynamically generate an alphabetical listing of the services (an A-Z listing). The screens below show an example (Note: at time of writing the screen design had not been finalised and A-Z test metadata was being used on Council sites to test Open Objects' new A-Z code). A joint Broadland & North Norfolk A-Z listing using the North Norfolk & Broadland style sheets looked like this:

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 18 of 28

Norfolk Connect Partnership – Portal Technical Manual

To have content listed in the A-Z generated by the Portal, there are 4 lines of metadata to add to each webpage you want listed. The first two lines must be included, the last two are optional: [Mandatory two lines:]
<meta name="DC.type" scheme="NCP" content="AtoZ" /> <meta name="DC.title" content="Arts" />

In the above, the Portal uses the first metadata item to identify that a webpage is for inclusion in the A-Z. In the second item you would replace "Arts" with the title you want to appear in the A-Z listing. [And Optional two lines:]
<meta name="DC.title.alternative" content=“Norfolk Arts Service; Literature netway" /> <meta name=“DC.coverage.spatial" scheme=”NCP.CouncilArea” content=“Norfolk County” />

In the above you would replace the two alternative titles "Norfolk Arts Service" & "Literature netway" with any additional/alternative titles you want to see in the A-Z listing that refer to the same webpage as above. A semi colon is used between multiple titles. Also, you would replace "Norfolk County" with your appropriate Council Area name as this value is displayed on the right-side of the listings when a joint A-Z listing is generated so that end-users can see which information/service comes from your Council and which comes from another. This name is not shown when doing an A-Z listing of just one site (eg, viewing only a Broadland A-Z listing from the Broadland site). The following provides an example of some test A-Z metadata relevant to Norfolk County Council: Under letters "A", "N", & "L", we want to have listed "Arts", “Norfolk Arts Service & "Literature netway" respectively, which when clicked would display the webpage: http://www.norfolk.gov.uk/leisure/arts/default.htm. To do this that webpage would have the metadata:
<meta name="DC.type" scheme="NCP" content="AtoZ" /> <meta name="DC.title" content="Arts" /> <meta name="DC.title.alternative" content=“Norfolk Arts Service; Literature netway" /> <meta name=“DC.coverage.spatial" scheme=”NCP.CouncilArea” content=“Norfolk County” />

Under letter "B", we want to have "Benefits" which when clicked would display the webpage: http://www.norfolk.gov.uk/advice/benefits/default.htm. To do this that webpage would have the metadata:
<meta name="DC.type" scheme="NCP" content="AtoZ" /> <meta name="DC.title" content="Benefits" />

Under letter "Y", we want to have "Your Norfolk" which when clicked would display the webpage: http://www.norfolk.gov.uk/news/yournorfolk.htm. To do this that webpage would have the metadata:
<meta name="DC.type" scheme="NCP" content="AtoZ" /> <meta name="DC.title" content="Your Norfolk" />

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 19 of 28

Norfolk Connect Partnership – Portal Technical Manual

So, from the above, the Open Objects Portal A-Z code would produce an A-Z listing for Norfolk County Council content which would contain the following items:
A Arts B Benefits L Literature netway N Norfolk Arts Service Y Your Norfolk Norfolk County Norfolk County

Norfolk County

In the above, "Benefits" and "Your Norfolk" does not have "Norfolk County" shown besides them because the “DC.coverage.spatial" metadata was not included on those webpages. At the time of writing, Broadland and North Norfolk have been able to implement the A-Z metadata because Broadland has access to their Tagish website templates and North Norfolk host their own website and have a Content Management System that they configured to automatically populate the metadata into their web pages. Norfolk County Council implemented the metadata manually on a few of their web pages prior to their Content Management System being implemented later in the year. The timescales for the other Partners to have implemented the metadata on their own sites is dependent on their individual plans for enhancing or changing their current website hosting requirements with Tagish.

10.1.

The URLs for calling a Joint A-Z listing

An example of the Open Objects URL for displaying a joint A-Z listing for the letter "Y" for Broadland, North Norfolk & Norfolk County Council using the County Council style sheet would be:

http://search2.openobjects.com/kbroker/ncc/norfolkcc/services/search.sim? sr=0&nh=50&cs=iso-8859-1&sc=&sm=3&to=0&mt=1&qt=Y&ha=268&ha=261&ha=262

This URL displays the following joint A-Z page generated by the Open Objects server:

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 20 of 28

Norfolk Connect Partnership – Portal Technical Manual

And adding "&ha=XXX" to the above URL would add A-Z content from an additional Partner that has a Handler Value equal to XXX. The Open Objects A-Z application uses different Handler Values (ha) to those used in the general Portal search application. The following table is specific to the A-Z application and shows each Partner's sub-directory name and Handler Value (ha): A-Z content from Breckland Broadland Great Yarmouth King's Lynn&West Norfolk South Norfolk Norfolk County Council Norwich City North Norfolk Handler Value (ha) 263 261 264 265 267 268 266 262 Sub-directory Name breckland broadland greatyarmouth westnorfolk southnorfolk norfolkcc norwich northnorfolk

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 21 of 28

Norfolk Connect Partnership – Portal Technical Manual

Similarly for the A-Z Listing, the following items seen in the URL differ to those in the general Portal search application: Item
qt mt

value
Y 1

result
Can be any letter of the alphabet. Here it would show the A-Z listing for the letter "Y" This item seems to be set to 1 by Open Objects, and unlike the general search application, changing the value does not seem to affect the AZ listing This item seems to be set to 1 by Open Objects, and unlike the general search application, changing the value does not seem to affect the AZ listing Displays up to 50 items per A-Z letter per page Displays the first page of 50 results Displays the second page of 50 results Displays the third page of 50 results etc Needs to be set to 3 in order to display an A-Z listing.

to

1

nh sr sr sr sm

50 0 50 100 3

10.2.

Joint A-Z search facility

Note: This "search" function is different to that of the Portal general search function as it is searching only the content that has been metatagged as being A-Z content. The screen below shows an example of the A-Z search facility:

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 22 of 28

Norfolk Connect Partnership – Portal Technical Manual

The URL for the above page is:
http://search2.openobjects.com/kbroker/ncc/northnorfolk/services/search.sim? qt=arts&sr=0&nh=50&cs=iso-8859-1&sc=nccbroad&sm=0&mt=1&ha=244

Some of the values used in the URL for an A-Z Search differ from those used in the A-Z Listing and general Portal search facility. The A-Z Search values are outlined in the tables below: A-Z Content Search Breckland Broadland Great Yarmouth King's Lynn&West Norfolk South Norfolk Norfolk County Council Norwich City North Norfolk Handler Value (ha) 245 243 246 247 249 250 248 244 Sub-directory Name breckland broadland greatyarmouth westnorfolk southnorfolk norfolkcc norwich northnorfolk Scope Value (sc)
nccbroad nccbroad nccbroad nccbroad nccbroad nccbroad nccbroad nccbroad

For example, adding &ha=250 to the URL above would search the A-Z content of Norfolk County Council (250) and North Norfolk (244). The following provides an overview of the other field values in the URL: Item
qt mt mt mt to nh sr sr sr sm sb hb

value
arts 0 1 2 1 50 0 50 100 1 0 1

result
Searches for the term "Arts" in pages that form the A-Z content Would do an "All words" search of A-Z content Would do an "Any words" search of A-Z content Would do an "Exact phrase" search of A-Z content Searches for the word/s in the "Title only" of A-Z content rather than the body Displays up to 50 results per page Displays the first page of 50 results Displays the second page of 50 results Displays the third page of 50 results etc Is set to 1 for an A-Z search Set by Open Objects to this value for the A-Z search Set by Open Objects to this value for the A-Z search

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 23 of 28

Norfolk Connect Partnership – Portal Technical Manual

11. Geo-referenced Searching
Open Objects have a Postcode gazetteer spreadsheet (headings shown below) provided by Norfolk County Council and are building functionality to enable a search to be made by geographic references. The search functionality will look up details from the spreadsheet and then search for pages which have those details contained within their metadata.
Postcode gazetteer (May 2003) (Norfolk and border areas) Postcode Postcode (7/8 figure) (7 figure)

Easting Northing County District Settlement code /Parish

1998 Wards (old) Parish code Name

2001 Census wards (new) code Name

Social Service area

PCT PCT code

One application envisaged for this functionality is a "Who's My Councillor" search, whereby entering a geographic reference, the search engine will look up a corresponding reference that is then searched for in metadata relating to Councillor information. Implementation of the metadata within Partner sites is unlikely in the short-term and as an interim, all Partner sites have Recommended Links that display information about County, District, Parish, MP & MEP contacts as shown below:

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 24 of 28

Norfolk Connect Partnership – Portal Technical Manual

These "Councillor/Elected Representative" Recommended Links are triggered by a search for any of the following words (or their plurals): • • • • • • • • • • • • • • • Councillor Elected Democracy Member MP Labour Conservative Liberal Democrat Lib Dem Parliament MEP Parish Representative Rep Clerk

12. Other documents available
Open Objects provided Portal training to the Norfolk Connect Partnership Team Managers in October 2003. All Team Managers were provided with technical manuals from Open Objects (an Administration Guide and a Customisation Guide). Related to the Portal, the Norfolk Connect Partnership has produced a metadata specification which has been agreed and circulated to Team Managers. The document provides details of metadata for Partners to use and how to implement it. The document is called: "NCP Metadata List NML version 1.0.doc". An electronic copy is held in the NCP Project Office directory S:\Ncp\Project Office\Work package 5 - Metadata.

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 25 of 28

Norfolk Connect Partnership – Portal Technical Manual

Appendices

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 26 of 28

Norfolk Connect Partnership – Portal Technical Manual

A. Key Open Objects URLs for each Partner

A.1 The General Portal Search facility for each Partner

Partner
Breckland Broadland Great Yarmouth King's Lynn&West Norfolk South Norfolk Norfolk County Council Norwich City North Norfolk

Open Objects URL
http://search2.openobjects.com/kbroker/ncc/breckland/search.jsp http://search2.openobjects.com/kbroker/ncc/broadland/search.jsp http://search2.openobjects.com/kbroker/ncc/greatyarmouth/search.jsp http://search2.openobjects.com/kbroker/ncc/westnorfolk/search.jsp http://search2.openobjects.com/kbroker/ncc/southnorfolk/search.jsp http://search2.openobjects.com/kbroker/ncc/norfolkcc/search.jsp http://search2.openobjects.com/kbroker/ncc/norwich/search.jsp http://search2.openobjects.com/kbroker/ncc/northnorfolk/search.jsp

A.2 The A-Z Listing facility for each Partner

Partner
Breckland Broadland Great Yarmouth King's Lynn&West Norfolk South Norfolk Norfolk County Council Norwich City North Norfolk

Open Objects URL
http://search2.openobjects.com/kbroker/ncc/breckland/services/search.sim? nh=50&sr=0&cs=iso-8859-1&qt=A&ha=263&sm=3 http://search2.openobjects.com/kbroker/ncc/broadland/services/search.sim? nh=50&sr=0&cs=iso-8859-1&qt=A&ha=261&sm=3 http://search2.openobjects.com/kbroker/ncc/greatyarmouth/services/search.sim? nh=50&sr=0&cs=iso-8859-1&qt=A&ha=264&sm=3 http://search2.openobjects.com/kbroker/ncc/westnorfolk/services/search.sim? nh=50&sr=0&cs=iso-8859-1&qt=A&ha=265&sm=3 http://search2.openobjects.com/kbroker/ncc/southnorfolk/services/search.sim? nh=50&sr=0&cs=iso-8859-1&qt=A&ha=267&sm=3 http://search2.openobjects.com/kbroker/ncc/norfolkcc/services/search.sim? nh=50&sr=0&cs=iso-8859-1&qt=A&ha=268&sm=3 http://search2.openobjects.com/kbroker/ncc/norwich/services/search.sim? nh=50&sr=0&cs=iso-8859-1&qt=A&ha=266&sm=3 http://search2.openobjects.com/kbroker/ncc/northnorfolk/services/search.sim? nh=50&sr=0&cs=iso-8859-1&qt=A&ha=262&sm=3

A.3 The A-Z Search facility for each Partner

Partner
Breckland Broadland Great Yarmouth King's Lynn&West Norfolk South Norfolk Norfolk County Council Norwich City North Norfolk

Open Objects URL
http://search2.openobjects.com/kbroker/ncc/breckland/services/search.jsp http://search2.openobjects.com/kbroker/ncc/broadland/services/search.jsp http://search2.openobjects.com/kbroker/ncc/greatyarmouth/services/search.jsp http://search2.openobjects.com/kbroker/ncc/westnorfolk/services/search.jsp http://search2.openobjects.com/kbroker/ncc/southnorfolk/services/search.jsp http://search2.openobjects.com/kbroker/ncc/norfolkcc/services/search.jsp http://search2.openobjects.com/kbroker/ncc/norwich/services/search.jsp http://search2.openobjects.com/kbroker/ncc/northnorfolk/services/search.jsp

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 27 of 28

Norfolk Connect Partnership – Portal Technical Manual

B. Sopra Action Request form

Below is the Sopra “Action Request” form. This should be used for requesting changes to the Portal, reporting faults and initiating queries with Open Objects. The form should be forwarded to the Sopra Helpdesk: helpdesk.stevenage@sopragroup.com

Sopra Group
Customer: Norfolk Portal Partnership
Raised By: XXX UAT Sytest Dev

Software Action Request System: Norfolk Portal
Sopra Group Ref: NPP001-## Project Code: NPP001 Priority

Date Raised: dd/mm/yy Phase: Live

Customer Ref: dd/mm/yy-X Other (Specify)

Description:

(Describe details of request or fault clearly. Include any information which is considered relevant. Use a separate sheet for more detail if required and attach any report output or screen dumps if available) Pages/Screen Dumps

Change / Fault / Query Description………..

Change

Fault

Query

No Action

Other:

Response or Action: (Describe in detail all proposed action including any specific testing requirements)

Impact on Project: (Describe how this SAR may impact any current or planned development for this project or customer)

Estimated Time PM Design Build Test PM

Estimated Cost Design Build Test

Software Estimate ref Maintenance

Total Estimated Time Estimated by: Estimate Accepted by: SAR Completed by:

Total Estimated Cost Date Estimated: Date Accepted: Date Completed:

(Shaded areas are for Sopra Group use only)

**End of Document**

S:\Ncp\Project Office\Work package 2 - Portal Rollout\Portal Technical Manual.doc

Page 28 of 28


								
To top