Wiki source code of Help Desk
Last modified by Vincent Massol on 2024/11/19 16:12
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
6.4 | 1 | {{toc start="2"/}} |
 |
1.4 | 2 | |
| |
5.1 | 3 | == Rationale == |
| |
1.4 | 4 | |
| |
5.1 | 5 | [[XPertNet (XPN)>>http://www.xwiki.com]] is taking part in the [[Nepomuk>>http://nepomuk.semanticdesktop.org]] research project together with [[Mandriva>>http://www.mandriva.com]]. One of the XPN contribution consists in creating a community help desk with semantic and P2P capabilities, putting into practice the Nepomuk components (see list below). In the frame of the Nepomuk context, the help desk will be experimented in particular by the community of Mandriva users. A detailed analysis of the Mandriva case study is available from the following report: [[NEPOMUK Deliverable D11.1>>http://nepomuk.semanticdesktop.org/xwiki/bin/view/Main1/D11%2D1]]. |
| |
1.4 | 6 | |
| |
5.1 | 7 | == Use cases == |
| |
1.12 | 8 | |
| |
5.1 | 9 | === Typical online help desk workflow === |
| |
1.4 | 10 | |
| |
1.8 | 11 | Joe can submit questions online. Others can answer. The worklow used is a typical help desk workflow: question and answer submission, categorization, notification, search and escalation. |
| |
1.4 | 12 | |
| |
5.1 | 13 | Note: we may consider the use of the library [[org.semanticdesktop.fsm>>http://dev.nepomuk.semanticdesktop.org/browser/trunk/java/org.semanticdesktop.fsm]] for implementing possibly complex workflows. |
| |
1.4 | 14 | |
| |
5.1 | 15 | === Document annotation capabilities === |
| |
1.4 | 16 | |
| |
5.1 | 17 | Hellen is browsing a discussion relating to the use of a the ATI x800 XL graphic card on a dual screen. She rates one of the answer brought as very useful. She also tags the author of that answer, Erin, as a master in the area of "graphic cards". She indicates that the thread relates to ATI hardware, dual screens, graphic cards, and to the specific ATI x800 XL model. Thanks to this metadata, the thread will pop up among the first results when other users search for similar issues. |
| |
1.4 | 18 | |
| |
5.1 | 19 | === Local annotation === |
| |
1.4 | 20 | |
| |
5.1 | 21 | This use case illustrates a typical interaction between a semantic desktop and the help desk. The help desk consists of general resources aiming at helping users to achieve specific tasks or to solve technical problems. Users willing to customize these resources for their own use, typically to create their own documented task list for achieving a given complex activity such as the set up of a private virtual network, are able to do so by using the Nepomuk semantic desktop to derive local semantic graphs and personal semantic task lists from the help desk resources. |
| |
1.4 | 22 | |
| |
5.1 | 23 | Each user is able to import semantic graphs from the help desk repository to their individual workspace. Users have the possibility to enhance the public graphs locally by adding concepts and relations that make sense to them, involving local desktop resources, for the purpose of learning and memorizing. |
| |
1.4 | 24 | |
| |
5.1 | 25 | This means that the semantic desktop lets the user associate a set of help desk resources and local notes with specific tasks she's doing regularly on her computer. The Nepomuk desktop allows to draw the link between the action pattern and the resources, and pops up the existing resource links when appropriate. |
| |
1.4 | 26 | |
| |
5.1 | 27 | === Rating of experts and of resources === |
| |
1.4 | 28 | |
| 29 | Users can rate experts and resources. | ||
| 30 | |||
| |
5.1 | 31 | === Social networking === |
| |
1.4 | 32 | |
| 33 | Users can form groups on the help desk, and comment on each other's wall. | ||
| 34 | |||
| |
5.1 | 35 | === Search based on recommendations by persons trusted by the user. === |
| |
1.4 | 36 | |
| |
5.1 | 37 | As Kim uses the Mandriva help desk more and more, he gets to know a large number of users and experts, who progressively become good acquaintances whom he trusts. Kim decides to create a group "friends" on the help desk, and adds his best online mates to the group. |
| |
1.4 | 38 | |
| |
5.1 | 39 | In creating such a group of friends, Kim can narrow his search to the resources (knowledge base pages, experts, questions and answers, or web sites) that are rated as interesting resources by his network of friends. This feature lets Kim discover more efficiently new trustful experts and resources that may are of interest to him. While browsing available resources, Kim also gets the information on what his friends think about the resources he's browsing. |
| |
1.4 | 40 | |
| |
5.1 | 41 | === Ad'hoc learning material creation === |
| |
1.4 | 42 | |
| |
5.1 | 43 | The help desk knowledge base contains a set of resources on various topics that can be harnessed for the creation of learning material taking into account constraints related to the profile of the target audience, such as the technical level of the participants, the duration of the learning session, and the language to be used. |
| |
1.4 | 44 | |
| |
5.1 | 45 | The semantic search engine makes it possible to easily retrieve resources matching a set of criteria reflecting the audience profile and timing constraints. Then, the help desk allows to combine documents using portions of different help desk resources. |
| |
1.4 | 46 | |
| |
5.1 | 47 | === Prompting contextual help === |
| |
1.4 | 48 | |
| |
5.1 | 49 | This use cases illustrates how the user context can be taken into account by the Nepomuk context manager for firing appropriate events aiming to assist the user in achieving his current activity. Kim just bought a new camera from Logitech. While he plugs his camera into the USB port of his computer, an assistant offers him to read the memo that he has entered about USB components, or to browse the resources related to this camera available in the help desk knowledge base. Kimhas the possibility to: |
| 50 | |||
| |
1.4 | 51 | * read tutorials in his language on how to take the most of this camera. He can choose to read tutorials that are available either in the community knowledge base or across his personal network of relationships knowledge bases |
| 52 | * read articles describing identified issues and workarounds related to the use of this given camera with his laptop model. | ||
| 53 | |||
| |
5.1 | 54 | === Command line interaction === |
| |
1.4 | 55 | |
| 56 | It should be possible to interact with the help desk directly from the command line. | ||
| 57 | |||
| |
5.1 | 58 | === Email integration === |
| |
1.4 | 59 | |
| |
5.1 | 60 | Users should for instance be able to interact with the system from an email client. |
| |
1.5 | 61 | |
| |
1.16 | 62 | * An email is sent to the customer when a response is brought to the submitted issue |
| 63 | * Customers can submit cases by email | ||
| 64 | |||
| |
5.1 | 65 | === P2P capabilities === |
| |
1.16 | 66 | |
| |
5.1 | 67 | Users should be able to share their local data with their friends: this will let them share personal wiki pages and the related metadata with others. |
| |
1.4 | 68 | |
| |
5.1 | 69 | === Other use cases and features === |
| |
1.4 | 70 | |
| |
5.1 | 71 | ==== Roles and workflow ==== |
| |
1.4 | 72 | |
| |
1.16 | 73 | * Submit, assign, prioritize, escalate issues |
| 74 | * Various persons and group of persons interplay with the system, with different right levels. | ||
| |
5.1 | 75 | |
| |
1.16 | 76 | Example: a given group of technicians will be allowed to bring support to a given set of customers |
| |
5.1 | 77 | |
| |
1.16 | 78 | * Assignment of a case to a technician or group of technicians |
| 79 | * Automatic escalation of cases when not closed in a given period of time | ||
| 80 | * Track multiple projects for multiple teams within a single installation | ||
| 81 | * Track critical system metadata, including time spent per action, due dates, and estimated time to completion. | ||
| 82 | * Lock the incidents to make sure several staff members are not working on the same case at the same time. | ||
| 83 | * Case view: each staff member must see the list of the incidents which need a reply and the list of incidents | ||
| |
5.1 | 84 | |
| |
1.16 | 85 | assigned to him. |
| |
5.1 | 86 | |
| |
1.16 | 87 | * Based on a rule/workflow system, some cases must be automatically updated. Example: Cases submitted by a given organization, |
| 88 | |||
| |
5.1 | 89 | or in the frame of a given contract must be automatically set to "support level 3" and affected to a given group of technicians. |
| |
1.16 | 90 | |
| |
5.1 | 91 | ==== Case assignment ==== |
| 92 | |||
| |
1.16 | 93 | * Manual + automatic case assignment. Possibility to define custom rules for automatic assignment |
| 94 | * Rights to reassign | ||
| 95 | |||
| |
5.1 | 96 | ==== Case updates ==== |
| |
1.16 | 97 | |
| 98 | * Who is allowed to update a case | ||
| 99 | * Who should be notified when a case is updated | ||
| 100 | * Calculation of time spent on each case and how it will effect representative?s productivity report and how is | ||
| |
5.1 | 101 | |
| |
1.16 | 102 | has to be linked with escalation mechanism. |
| 103 | |||
| |
5.1 | 104 | ==== KB integration ==== |
| |
1.16 | 105 | |
| |
5.1 | 106 | * Integration with a wiki based knowledge base, so that the products supported are linked to the knowledge base |
| |
1.16 | 107 | |
| 108 | containing solutions to common problems. | ||
| 109 | |||
| |
5.1 | 110 | ==== Reporting ==== |
| |
1.16 | 111 | |
| 112 | * Time tracking | ||
| 113 | * Statistics per category / issue level / team (for example: Sound problems / Drive problems / RAID problems / | ||
| |
5.1 | 114 | |
| |
1.16 | 115 | Apache problems etc) |
| |
5.1 | 116 | |
| |
1.16 | 117 | * Gantt charts |
| 118 | * Printable view of a case thread | ||
| 119 | |||
| |
5.1 | 120 | ==== Rights management ==== |
| |
1.16 | 121 | |
| 122 | see who can update/close/reopen/move etc. issues | ||
| 123 | |||
| |
5.1 | 124 | == Components and ontologies == |
| |
1.4 | 125 | |
| |
5.1 | 126 | === Components === |
| |
1.6 | 127 | |
| |
5.1 | 128 | Beside the [[XWiki platform components>>Design.Architecture V2]], the XWiki help desk will use the following components and ontologies: |
| |
1.4 | 129 | |
| |
5.1 | 130 | (% style="list-style-type: square" %) |
| 131 | * [[RdfRepository>>http://dev.nepomuk.semanticdesktop.org/browser/trunk/java/org.semanticdesktop.nepomuk.comp.rdfrepository]]: this component is an API for storing and querying metadata | ||
| 132 | * HelpDeskWorkflow: this component will manage the state of question and answers (we may consider using [[this FSM implementation>>http://dev.nepomuk.semanticdesktop.org/browser/trunk/java/org.semanticdesktop.fsm]]) | ||
| 133 | * XWikiRdfExtractor: this component crawls an XWiki database and converts the metadata into RDF statements. | ||
| 134 | * Annotator: this component will make it possible to annotate resources for the purpose of tagging, rating, adding various metadata. Annotations can be brought either online, or on a local desktop | ||
| 135 | * [[PSEW>>http://nepomuk-eclipse.semanticdesktop.org/xwiki/bin/view/Main/PSEW]]: PSEW stands for P2P Semantic Eclipse Workbench. It includes XEclipse. It is a general workbench for working with metadata related to local or remote resources. | ||
| 136 | * [[FolkPeer>>http://nepomuk.semanticdesktop.org/xwiki/bin/view/Main1/D5%2D1]]: this component can identify similarities across metadata | ||
| 137 | * GridVine: this component is a P2P RDF indexing system. It is described in [[this paper>>http://citeseer.ist.psu.edu/aberer04gridvine.html]]. | ||
| |
1.4 | 138 | |
| |
5.1 | 139 | === Data models for annotation === |
| |
1.4 | 140 | |
| |
5.1 | 141 | Nepomuk has designed various data models that will be used for adding metadata to resources. These data models are available from [[the NEPOMUK ontology page>>http://www.semanticdesktop.org/ontologies/]]. They consist of the following: |
| |
1.4 | 142 | |
| |
5.1 | 143 | (% style="list-style-type: square" %) |
| 144 | * the NEPOMUK Annotation Ontology (NAO): NAO is an ontology for annotation, providing vocabulary which is commonly required to annotate resources on the semantic desktop. NAO includes graph metadata vocabulary for describing, or annotating, existing named graphs. | ||
| 145 | * the NEPOMUK Information Element (NIE): NIE is set of ontologies provide vocabulary for describing information elements which are commonly present on the semantic desktop: NIE (core) - NEPOMUK Information Element Core Ontology, NFO - NEPOMUK File Ontology, NCO - NEPOMUK Contact Ontology, NMO - NEPOMUK Message Ontology, NCAL - NEPOMUK Calendar Ontology, NEXIF - NEPOMUK EXIF Ontology, NID3 - NEPOMUK ID3 Ontology | ||
| 146 | * NEPOMUK's Representational Language (NRL): Designed on top of RDF, it addresses certain limitations on the part of RDF/S. In particular it includes support for Named Graphs, which although being a widely-popular notion, have not been supported by any representational language so far. It is also based on a view concept for the tailoring of ontologies. This view concept turned out to be of additional value, as it also provides a mechanism to impose different semantics on the same syntactical structure. | ||
| 147 | * SKOS http://www.w3.org/TR/2005/WD-swbp-skos-core-guide-20050510/ | ||
| |
1.4 | 148 | |
| |
5.1 | 149 | == Proposal == |
| |
1.4 | 150 | |
| |
5.1 | 151 | (% style="list-style-type: square" %) |
| 152 | * Create a new JIRA project for describing use cases, tasks, requirements | ||
| 153 | * Describe further the use cases | ||
| 154 | * Create a first application implementation | ||
| 155 | * Link the implementation with the PSEW prototype | ||
| |
1.4 | 156 | |
| |
5.1 | 157 | === Data model === |
| |
1.4 | 158 | |
| |
5.1 | 159 | See [[Design.HelpDeskDataModel]] |
| |
1.15 | 160 | |
| |
5.1 | 161 | == Other help desk systems == |
| |
1.15 | 162 | |
| |
5.1 | 163 | See [[Design.HelpDeskWatch]] |
| |
1.4 | 164 | |
| |
5.1 | 165 | == Roadmap == |
| |
1.4 | 166 | |
| |
5.1 | 167 | (% style="list-style-type: square" %) |
| 168 | * 30 September 2007: release of a first implementation of the help desk | ||
| 169 | * 15 October 2007: release of a report assessing the prototype from the user point of view | ||
| 170 | * 30 October 2007: release of the second implementation, and presentation of the system | ||
| |
1.4 | 171 | |
| |
5.1 | 172 | at the [[eChallenges Conference>>http://www.echallenges.org/e2007/default.asp?page=schedule-view&schedule.expanded=yes&schedule.day.pos=3]]. |
| |
1.4 | 173 | |
| |
5.1 | 174 | == Notes == |
| |
1.4 | 175 | |
| |
5.1 | 176 | The features of an help desk are close to the ones of an issue tracker. We may consider evolve the features to a set of core functionalities from which we could derive two products: XWiki help desk and XWiki issue tracker. |
| 177 | |||
| 178 | == Other help desk pages == | ||
| 179 | |||
| 180 | {{velocity filter="none"}} | ||
| |
1.19 | 181 | #foreach($childDocName in $xwiki.searchDocuments("where doc.parent='$doc.fullName' order by doc.name")) |
| 182 | #set($childDoc = $xwiki.getDocument($childDocName)) | ||
| |
5.1 | 183 | * [[$childDoc.displayTitle>>$childDoc.fullName]] |
| 184 | |||
| |
1.18 | 185 | #end |
| |
1.20 | 186 | |
| |
5.1 | 187 | {{/velocity}} |
 |
2.1 | 188 | |
| |
5.1 | 189 | == Other related tools == |
| 190 | |||
| |
2.1 | 191 | Issue tracking tools: |
| |
5.1 | 192 | |
| 193 | * [[JIRA>>http://www.atlassian.com/software/jira/]] | ||
| 194 | * [[Eventum>>http://dev.mysql.com/downloads/other/eventum/features.html]] |
