Requirements Specification of the Vertical Industrial Use Case ... - IKS

2 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseCopyrightNoticeThis document contains material, which is the copyright of certain IKS consortiumparties, and may not be reproduced or copied without permission. Thecommercial use of any information contained in this document may require alicense from the proprietor of that information. Neither the IKS consortium as awhole, nor a certain party of the IKS consortium warrant that the informationcontained in this document is capable of use, nor that use of the information isfree from risk, and accepts no liability for loss or damage suffered by any personusing this information.Neither the European Commission, nor any person acting on behalf of theCommission, is responsible for any use which might be made of the informationin this document.The views expressed in this document are those of the authors and do not necessarilyreflect the policies of the European Commission.IKS is co-funded by the EuropeanUnion and develops technology forintelligent content managementTable of ContentsDocument Information ........................................................................................................... 3IKS in a Nutshell ..................................................................................................................... 4Executive Summary ............................................................................................................... 41 Vertical Industrial Use Cases ....................................................................................... 51.1 Software Engineering ............................................................................................ 51.2 News Market for Journalists’ Teams .................................................................... 161.3 Portal Market for Travel Agencies ....................................................................... 212 Requirements Specification Methodology ............................................................... 262.1 High-level requirements ....................................................................................... 262.2 Requirements refinement process ....................................................................... 262.3 IKS Actor Model for Requirements Capture ........................................................ 283 High Level Requirements ........................................................................................... 313.1 HLR-2301: Content clustering ............................................................................. 313.2 HLR-2302: Traceability among content items ...................................................... 603.3 HLR-2303: Calculation of correlation among content .......................................... 933.4 HLR-2304: Information Extraction ..................................................................... 1073.5 HLR-2305: Content Enrichment ......................................................................... 1423.6 HLR-2306: Personalized content search assistance ......................................... 1624 Summary and Further Steps .................................................................................... 1845 References ................................................................................................................. 1846 Annex ......................................................................................................................... 1856.1 Final requirements listings ................................................................................. 185© IKS Consortium2010

3 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseDocument HistoryVersion Name Date RemarkV01 Benjamin Nagel 2009-11-19 Initial versionV02 Benjamin NagelGianluigi Di Vito2010-01-18 Scenarios and high-level requirements from TXTand UPBV03 Benjamin Nagel 2010-03-02 Setting up draft online versionV04 Benjamin Nagel 2010-03-05 Minor changes in section 1.1Added section 3V05 Benjamin Nagel 2010-03-10 Added section 1Added section 2V06 Benjamin Nagel 2010-03-16 Updated section 3V07Benjamin NagelAlexander Weiss2010-03-18 Scenarios and high-level requirements fromCIC/PisanoUpdated section 3V08 Benjamin Nagel 2010-03-29 Updated section 3V09 Benjamin NagelAlexander Weiss2010-04-05 Adding section 1.3Updated section 3V10 Benjamin Nagel 2010-04-06 Finalisation of deliverableV11 Benjamin Nagel 2010-05-10 Updated according to QA FeedbackV12 Benjamin Nagel 2010-05-19 Updated according to QA FeedbackDocument InformationItemValueIdentifier IKS-231527-Deliverable 2.3-2010Author(s):Document title:Source Filename:Actual Distribution levelDocument context informationBenjamin Nagel, Stefan Sauer, Gregor Engels (University of Paderborn)IKS Deliverable – 2.3 Report:Requirements Specification for the Vertical Industrial Use Caseiks-d23-reqspec_ver_case-20100519_final.docxRestrictedProject (Title/Number) Interactive Knowledge FP7 231527Work package / Task WP2 / T2.3Responsible person andproject partner:Quality Assurance / ReviewName / QA / Release / CommentCitation informationBenjamin Nagel,s-lab, University of PaderbornWernher Behrendt, Andreas GruberSRFGOfficial citation Benjamin Nagel, Gregor Engels, Stefan Sauer, 2010: IKS Deliverable. D2.3Report: Requirements Specification for the Vertical Industrial Use Case© IKS Consortium2010

4 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseIKS in a Nutshell“Interactive Knowledge Stack” (IKS) is an integrating project targeting small to medium ContentManagement Systems (CMS) providers in Europe providing technology platforms forcontent and knowledge management to thousands of end user organizations. Current CMStechnology platforms lack the capability for semantic web enabled, intelligent content, andtherefore lack the capacity for users to interact with the content at the user’s knowledge level.The objective of IKS therefore, is to bring semantic capabilities to current CMS frameworks.IKS puts forward the “Semantic CMS Technology Stack” which merges the advances in semanticweb infrastructure and services with CMS industry needs of coherent architecturesthat fit into existing technology landscapes. IKS will provide the specifications and at leastone Open Source Reference Implementation of the full IKS Stack. To validate the IKS Stackprototype solutions for industrial use cases ranging from ambient intelligence infotainment,project management and controlling to an online holiday booking system will be developed.Executive SummaryThe objective of this deliverable is to provide requirements for IKS by analysing industrialvertical use cases and their domain-specific needs. We decided to look at three different domainsin order to factor out common features and real, domain specific requirements. Thedomains “software engineering”, “news market for journalists’ teams” and “portal market fortravel agencies” were analyzed. Addressing the needs of the domain “software engineering”existing requirements management (RM) and application lifecycle management (ALM) toolswere analyzed with respect to their semantic capabilities. By identifying as yet, unsupportedfunctionalities, a set of high-level requirements for this domain was derived.The existing CMS of the industrial partners TXT and CIC/Pisano were analyzed addressingthe domains “news market for journalists’ teams” and “portal market for travel agencies”, respectively.Furthermore business goals and scenarios from these domains were captured toelicit their domain specific requirements. Using a formalised process for refining requirements,concrete lower-level requirements were derived from the high-level goals. As a result,requirements from three different domains with different business-driven goals were gatheredfor the specification of requirements for the IKS.Section 1 describes each of the three application domains and points at specific challengesthat the domain poses for content management. In section 2 the methodology for requirementsspecification and refinement are described. This includes a model of Actors to be usedfor describing the stakeholders of the various requirements. Section 3 contains the main outcomeof this work: a set of more than 120 concrete and testable requirements derived fromthe domain-specific high-level requirements.This deliverable should be seen in the context of other work in the first phase of IKS, all ofwhich led to specifications of requirements, from different perspectives: D 1.3 generated requirementsfrom analyses of surveys as well as from analyses of benchmarking exercisesconducted by industrial partners. D2.1. (Ambient Intelligence Case) and D2.4 (Project ControllingTool) generated detailed requirements for two larger scale usage scenarios which willlead to software demonstrators for IKS. D2.2 was the counterpart of this deliverable, lookingat hoizontal, i.e. generally valid requirements for semantics-enhanced CMS. A consolidatedset of requirements is expected once the results of WP3 (Requirements from the perspectiveof the layers of the IKS Stack) are finalised and merged with those of WP1 and WP2.© IKS Consortium2010

5 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case1 Vertical Industrial Use CasesThis section gives an overview about the different domains analyzed in the vertical industrialuse case. The investigation of domain specific applications will lead to a list of high-level requirementswhich provide the starting point for the requirements specification process finallybringing up concrete and testable requirements.One the one hand, the software engineering domain is analyzed from a more theoretical perspective.Therefore the specific needs for the management of the different kinds of contentitems created in the software engineering process are investigated. Furthermore an evaluationof the tool support by existing ALM tools is done to identify missing capabilities in thestate-of-the-art. Finally the remaining challenges for the management of software engineeringartefacts are described and the IKS high-level requirements from this domain are derived.On the other hand domains of CMS providers focussing on “news market for journalists’teams” and “portal market for travel agencies” are part of the investigation. Industrial partners(TXT and PISANO) working in these domains provide input for the specification of high-levelrequirements and corresponding scenarios driven by their business needs to the InteractiveKnowledge Stack. Furthermore the existing CMS are analyzed regarding their capabilitiesand desirable capabilities or enhancements are identified.1.1 Software EngineeringIn this section the software engineering domain is introduced as the first vertical industrialuse case of the analysis. In order to derive high level requirements for this domain, the softwareengineering domain and the central concepts behind it are investigated, focussing onthe artefacts and content items that have to be managed in the software engineering process.The discipline of software engineering aims at the development of software at a high level ofquality. The research done in this field led to different approaches, processes and methodologiessupporting the engineering of software in different phases through the whole lifecycle.In the first step, the actual needs and requirements which should be addressed by the softwarehave to be identified. Therefore the stakeholder requirements are elicited, documentedand consolidated. The requirements engineering process is a consequent refinement approachstarting from business related high-level requirements which are successively refinedinto concrete software requirements (comparable to the structure and approach of this deliverable).The software addressing these requirements can be designed by using architecturaldescription languages (ADLs) like UML. The design is done on different levels of abstraction.Identified layers and modules represent logical groups of reusable components. In a moreconcrete granularity the components itself, their subcomponents, interfaces and relations aredesigned. The designed software is implemented in an appropriate programming languageand tested against the requirements.Existing process models (e.g. waterfall, agile approaches) provide frames for managing themain activities: Analysis, Design, Implementation and Test. Nevertheless, in addition to theorganization of these activities a remaining challenge is the management of the contentwhich is created in the different activities.1.1.1 Content Items in the Software Engineering ProcessAs described in the previous section, different kinds of content items are created in the softwareengineering process. We will investigate the activities Analysis, Design, Implementation© IKS Consortium2010

6 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Caseand Test and the relevant artefacts. Figure 1 gives a schematic overview about the activitiesand their relations.Figure 1: Simplified software engineering process with related content itemsIn the Analysis phase the requirement are specified. These specifications describe the resultsof the requirements analysis and the derived requirements on different levels of abstractions(Table 1: Content items in the analysis phase). Furthermore different notations areused for the documentation. Textual descriptions are used to list and explain high-level requirementsand business needs to the software. Semi-formal notations, like UML use caseand activity diagrams are used to describe business and system processes which are relevantin the context of the system. One way of modelling software requirements is the usageof key word based approaches (e.g. [RFC1997]) which are a special form of natural language.The requirements specification provides a description of the problem space which isaddressed by the further steps (Design, Implementation, Test).Table 1: Content items in the analysis phaseContent itemsHigh-level requirements,business goals descriptionBusiness / system processanalysisBusiness objects specificationContext definitionSoftware requirements specificationsDescriptionInformal textual description of high-level requirements. Template-baseddocumentation structure.Semi-formal description of relevant business and technicalprocesses, described by use cases, activity diagrams orBPMN process diagrams.Semi-formal domain model using standards, like UML classdiagram.Semi-formal graphical context diagram.Textual description using keyword-based templates[RFC1997]The architectural design bridges the gap between the requirements and the actual implementationof the system by designing solutions addressing the requirements. The design and architectureof software can be described from different perspectives, e.g. context, structural,behavioural or deployment view. Each perspective describes the architecture from anotherpoint of view using a specific notation. In addition, each view can be modelled at differentlevels of abstraction representing the different granularities of design ranging from high-levelanalysis architectures to concrete component interface design. Therefore the content createdin the design phase (see Table 2: Content items in the design phase (views according to[Posch2004])) of the software engineering process is available in heterogeneous notations.© IKS Consortium2010

7 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseThe descriptions on different levels of abstraction are related to each other. Furthermore thedesign artefacts are directly related to the requirements specified in the Analysis.Table 2: Content items in the design phase (views according to [Posch2004])Content itemsContext view specificationStructure view specificationBehaviour view specificationDeployment / Allocation viewspecificationDescriptionThe context view provides a black box perspective on thesystem and the relations to other systems in the context.The context view can be described by use case, activity orcomponent diagrams.The structural view defines a static view of the system. Thestructure can be described by semi-formal notations, likeUML class diagrams, component diagrams or package diagrams.The behaviour view describes the dynamic aspects of thesystem. The behaviour can be defined by semi-formal models,e.g. interaction diagrams or sequence diagrams. Formalarchitectural description languages (ADLs), like SDL or the Znotation can also be used to describe dynamic models oraspects.The deployment or allocation view defines the technical ororganizational aspects of the system. Semi-formal UML deploymentdiagrams describe the assignment of componentsor modules to physical objects.After designing the architecture, software is implemented following the designed specifications.Even in this very technical activity, different kinds of content items are created andneed to be managed. The source code itself, represents content that could be directly generatedfrom designed models following the Model-driven development (MDD) paradigm. In additionto the source code, source code documentation, API documentations, SVN check-incomments and other kinds of developer documentation are created, as shown in Table 3:Content items in the implementation phase. The different kinds of content are directly or indirectlyrelated to the content created in the previous phases Analysis and Design.Table 3: Content items in the implementation phaseContent itemsSource codeSource code documentationTechnical documentationTechnical correspondenceabout the softwareDescriptionThe source code itself, implementing the software is writtenin the programming language specific format. This kind ofdocumentation is only readable by software developers orproject members with a technical background.The source code documentation is described as informaltextual description of the implementation. It is added to thesource code and can be generated to a separate documentationitem (e.g. HTML export in Eclipse).The technical documentation of the software is given informallyby a textual or graphical description.The technical correspondence includes different informalkinds of information about the software, e.g. SVN check-in© IKS Consortium2010

8 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Casecomments or blogs.In the Test phase, the implemented software is validated against the specified requirements.Documenting the different steps in the testing phase, various artefacts are created. Followingthe recommended IEEE Standard for Software Test Documentation [IEEE1998a], three differentkinds of documents are created:1. Test plan: Describing scope, approach, resources and schedule of the software test2. Test specification: Defines the test design, test cases and the test procedure3. Test reporting: The reporting is covered by an item transmittal report, test logs, testincident reports and a test summary report.Table 4: Content items in the test phase (according to [IEEE1998a])Content itemsTest PlanTest Design SpecificationTest Case SpecificationTest Procedure SpecificationTest Item Transmittal ReportTest LogTest Incident ReportTest Summary ReportDescriptionA document describing the scope, approach, resources, andschedule of intended testing activities. It identifies test items,the features to be tested, the testing tasks, who will do eachtask, and any risks requiring contingency planning.A document specifying the details of the test approach for asoftware feature or combination of software features andidentifying the associated tests.A document specifying inputs, predicted results, and a set ofexecution conditions for a test item.A document specifying a sequence of actions for the executionof a test.A document identifying test items. It contains current statusand location information.A chronological record of relevant details about the executionof tests.A document reporting on any event that occurs during thetesting process which requires investigation.A document summarizing testing activities and results. It alsocontains an evaluation of the corresponding test items.1.1.2 Management of Software Engineering ArtefactsThe artefacts, described in section 2.1.1 are created by different actors in the software engineeringprocess, e.g. business analysts, requirements engineers, software architects, softwaredevelopers, test managers, software tester etc. Typically, these actors are experts in aspecific domain, e.g. the elicitation of requirements. Thereby, the artefacts created by the actorsreflect the knowledge and state-of-the-art in the corresponding domain and are not necessarilyaligned to each other.Nevertheless, on a logical level the different artefacts are strongly related to each other. E.g.the functionality described in a software requirement during the Analysis is implemented in acomponent specified in the Design. This component is implemented in source code and theimplementation is documented in the code. The implemented component is finally testedbased on a defined specified test case against the corresponding requirements.© IKS Consortium2010

9 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseThe main challenge is to trace these relations among the heterogeneous artefacts created inthe software engineering process. In the software engineering domain, the consistent definitionof these dependencies and relations is called traceability.In large and complex software projects the specifications (requirement specification, architecturaldescription etc.) also become quite complex. For a project manager or a new teammember joining the project at a later point in time, it is very difficult to get an overview aboutthe distributed information provided in the different artefacts. It remains unclear, which artefactsare related to each other (traceability) and which artefacts are addressing the same topics.For example, different software requirements are not directly related to each other, butare defining requirements for the graphical user interaction (GUI). If a software developerwants to implement different GUI elements it could be become quite difficult and timeintensiveto gather all requirements and design specification dealing with the GUI. In order tohandle the bulk of information and to identify the relevant content items, the capability ofclustering and categorizing the existing information allows an effective work on the SE artefacts.In addition to the problem of identifying relevant information, the consolidation of the informationis another challenge in handling specifications of large software projects. An importantpoint in the early phase of the software engineering process is the consolidation of the requirementsspecification. In this consolidation step, the requirements specification is checkedfor redundancy and inconsistencies. The content management for these artefacts shouldsupport the involved project members or teams in identifying duplicates or inconsistencies.1.1.3 Content Management support by existing RE 1 / RM 2 and ALM 3ToolsAccording to the analysis of the content items created in the software engineering process(section 2.1.1) and the required management of these artefacts (section 2.1.2) the support byexisting RE/RM and ALM tools is evaluated in this section. The main challenges identified inthe previous section: Traceability, Clustering and Consolidation and their support is evaluated.1.1.3.1 Definition of Evaluation CriteriaTraceabilityAs discussed in the previous section, ensuring traceability among the different artefacts inthe software engineering process is very challenging especially in large projects. The evaluationof the corresponding capabilities focuses on the (semi-)automatic creation of links, representingthe different kinds of relations among the content items.Criteria1. Horizontal linking of requirements(common level of abstraction)2. Vertical linking of requirements(different levels of abstraction)DescriptionThe tool supports the creation of links between requirementson the same level of abstraction (e.g.:between different business use case diagrams).The tool supports the creation of links between requirementson different levels of abstraction (e.g.:1 RE - Requirements engineering2 RM - Requirements management3 ALM - Application lifecycle management© IKS Consortium2010

10 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case3. Different kinds of relations betweenrequirements4. Unique identification of the requirements5. Linking between requirementsand other artefacts6. Different kinds of relations betweenrequirements and otherartefactsbetween high-level requirements and related softwarerequirements).Different kinds of relations can be defined betweenrequirements (e.g.: “depends on”, “is extension of”).The different requirements can be identified by aunique identifier as a prerequisite for the traceability.The tool supports the creation of links between requirementsand other artefacts (e.g. design specifications).Different kinds of relations can be defined betweenrequirements and other artefacts (e.g.: “dependson”, “is extension of”).Clustering & AnnotationHandling artefacts in large software development projects requires an effective and wellarrangedorganization of the content items. Clustering and annotation of content are appropriatetechniques to manage the categorization and organization of content. By evaluatingwith respect to the following criteria, the support of such functionalities by existing RE/RMand ALM tools is analyzed.Criteria7. Definition of tags (user-definedor predefined)8. Annotation of artefacts usingtags9. Filtering and searching of artefactsby tags10. Clustering / categorization ofartefactsDescriptionThe tool supports the definition of tags of predefinedor user-defined types.Artefacts can be annotated by assigning tags tothem.The artefacts can be filtered or searched by thetags assigned to them.The artefacts can be clustered by using specific criteriaor rules.ConsolidationIn the field of requirements engineering and management, content gathered from differentpersons and perspectives is brought together. The consolidation of these requirements iscrucial for the further steps in the software engineering process. By analyzing the validationfunctionalities the support of the consolidation by existing tools is evaluated.Criteria11. Checks for consistency betweenrequirements12. Checks for consistency of relationsbetween requirements13. Check requirements for redundancyDescriptionThe tool provides a set of rules to check the consistencybetween requirements.The tool provides a set of rules to check the consistencyof relations between requirements.The tool provides a redundancy check, which identifiessimilar requirements.Addressing the criteria defined above, three different RE/RM and ALM tools have beenevaluated. The evaluation has been done with the following tools: IBM Rational DOORS / Rational Requirements Composer (IBM)© IKS Consortium2010

11 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case Polarion Requirements (2.0) / Polarion ALM (Polarion Software) Enterprise Architect 7.5The results of the evaluation are described in the following section.1.1.4 Evaluation of existing ToolsIBM Rational DOORS (formerly Telelogic, since 2008 IBM) 4 / Rational RequirementsComposer (IBM) 5CriteriaTraceability1. Horizontal linking of requirements(common level of abstraction)2. Vertical linking of requirements3. (different levels of abstraction)4. Different kinds of relations betweenrequirements5. Unique identification of the requirements6. Linking between requirementsand other artefacts7. Different kinds of relations betweenrequirements and otherartefactsClustering & Annotation8. Definition of tags (user-definedor predefined)9. Annotation of artefacts usingtags10. Filtering and searching of artefactsby tags11. Clustering / categorization of artefactsConsolidation12. Checks for consistency betweenrequirements13. Checks for consistency of relationsbetween requirements14. Check requirements for redundancyIBM Rational DOORS /Rational Requirements Composer- The requirements can be linked manually by drag &drop- System- and user-requirements can be linked manuallyby drag & drop- No support of different kinds of relations between requirements- Standard URL technology for addressing requirementsartefacts- Linking requirements and imported design artefactsmanually by drag & drop- No support of different kinds of relations between requirementsand design artefacts- User defined tag groups / tags- Tag values can be defined by the user- Tags can be assigned to requirement artefacts manually- Filtering and searching for requirements by specific tags- Categorization by tag(s) matching---------4 http://www-01.ibm.com/software/awdtools/doors/productline/5 http://www-01.ibm.com/software/awdtools/rrc/© IKS Consortium2010

12 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CasePolarion Requirements (2.0) / Polarion ALM (Polarion Software) 6CriteriaTraceability1. Horizontal linking of requirements(common level of abstraction)2. Vertical linking of requirements3. (different levels of abstraction)4. Different kinds of relations betweenrequirements5. Unique identification of the requirements6. Linking between requirementsand other artefacts7. Different kinds of relations betweenrequirements and otherartefactsClustering & Annotation8. Definition of tags (user-definedor predefined)9. Annotation of artefacts usingtags10. Filtering and searching of artefactsby tags11. Clustering / categorization of artefactsConsolidation12. Checks for consistency betweenrequirements13. Checks for consistency of relationsbetween requirements14. Check requirements for redundancyPolarion Requirements 2.0 /Polarion ALM- Linking requirements, tasks, etc.- Traceability Matrix- Automatic linking by creating the requirements in a hierarchicalstructure- Predefined set of relations:o is related too is depended upono is duplicated byo is parent ofo is follow-up ofo is implemented by- Unique IDs for requirements- Imported design artefacts (e.g. Sparx Enterprise Architect)can be linked manually with work items like requirementsspecifications- Simple linking supported- User defined tags- Tags can be assigned to requirements (categories)- Creation of query for enhanced searching and filteringcapabilities- Clustering capability is partly achieved by query construction- Manually setting of “suspect” links between requirements- No (semi-) automatic consistency check- Manual setting of “suspect” links between requirements- No (semi-) automatic consistency check- No redundancy checks provided6 http://www.polarion.com© IKS Consortium2010

13 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseEnterprise Architect 7.5Criteria Enterprise Architect 7.5Traceability1. Horizontal linking of requirements(common level of abstraction)2. Vertical linking of requirements3. (different levels of abstraction)4. Different kinds of relations betweenrequirements5. Unique identification of the requirements6. Linking between requirementsand other artefacts7. Different kinds of relations betweenrequirements and otherartefactsClustering & Annotation8. Definition of tags (user-definedor predefined)9. Annotation of artefacts usingtags10. Filtering and searching of artefactsby tags11. Clustering / categorization of artefactsConsolidation12. Checks for consistency betweenrequirements13. Checks for consistency of relationsbetween requirements14. Check requirements for redundancy- Manual definition of links between requirements (relationshipmatrix)- Manual linking requirements on different levels of abstraction(relationship matrix)- Various predefined relation types (based on UML 2.1standard)- Auto-numbering facility for unique references- Manual definition of links between requirements anddesign artefacts (relationship matrix)- Various predefined relation types (based on UML 2.1standard)- Set of predefined attributes and dialog-based creationof user-defined attributes- Requirements can be specified by assigning attributesand defining corresponding values- Provides pre-defined searches for tagged values------------1.1.5 Challenges of Content Management in the Software EngineeringDomainThe challenges are identified from the analysis of relevant content items and their managementin sections 1.1.1 and 1.1.2 and the evaluation in section 1.1.4. Thereby three mainchallenges which are currently not sufficiently supported by existing tools have been identified:1. Clustering of artefacts2. Traceability among software engineering artefacts3. Redundancy check© IKS Consortium2010

14 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseIn the following sections, these challenges are described in more detailed and their relevancefor the vertical industrial use case of the domain “software engineering” is described.1.1.5.1 Clustering of ArtefactsThe clustering of content provides algorithms for the (semi-) automatic creation of contentclusters. Such clusters group cross-media items or artefacts which address the same topic,e.g.: “The interaction of the user with content”. Figure 2 gives a schematic overview aboutthe general approach to content clustering, bringing together content from different levels ofabstraction and in various notations.Figure 2: Clustering of content itemsAccording to the current capabilities of ALM tools, there are still desirable features and functionalitiesfor the clustering of software engineering artefacts and these are currently unsupported.It should be possible to automatically cluster content items from different activities ofthe software engineering process. This requires the capability to analyse different kinds ofcontent items and to define by which criteria these items should be clustered. In addition, appropriatelabels for the clusters should be defined, which identifies the common topic addressedby the clustered content items.© IKS Consortium2010

15 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case1.1.5.2 Traceability among Software Engineering ArtefactsThe traceability among content items is realized by the (semi-)automatic creation of links betweenthe different content items. As shown in Figure 3, different kinds of links represent therelations among the artefacts.Figure 3: Traceability among software engineering artefactsThe analysis of existing tools has shown that these still lack capabilities to (semi-) automaticallycreate links between content items to provide traceability. At first, it needs to be possibleto specify different kinds of relations that can be defined between content items andcorresponding rules for the creation of these relations. Furthermore, a CMS should be able toanalyse content items described in different notations, and relate them to each other accordinga given rule set. In other words, current software engineering tools are weak on basicCMS as well as semantic CMS functionality.1.1.5.3 Redundancy CheckThe redundancy check for software engineering artefacts should support the consolidation ofsoftware specifications. Therefore duplicates, especially in the requirements specificationshould be identified. The calculation of the similarity between different requirement descriptionscan also be used to aggregate content items.On the one hand, there is the need for reorganization and consolidation of requirements especiallyin large, complex software projects. On the other hand, is there not sufficient supportby current RE/RM and ALM tools as shown in section 2.1.4. Thus the calculation of similaritiesamong content items and the identification of duplicates are still open challenges for themanagement of software engineering artefacts.© IKS Consortium2010

16 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case1.2 News Market for Journalists’ TeamsThe internet has changed the news market and has had impact on both the role of journalistsand the expectations of audiences. The job of the journalist is constantly evolving. Journalistsused to be working entirely within the field of newspaper writing, but radio and then TVchanged all that. The internet has created further opportunities for just about anybody tocover news, but merely reporting the news does not make one a professional news reporter.Reporters are more and more expected to be analysts as well, who report news but also dynamicallycreate and update interesting threads and narratives.Even if online publishing is often associated with a fast paced and direct form of journalism, itis in fact an extremely rich medium that can be used in a broad variety of fashions. Besidessimply publishing short articles on the Web, an editor can also produce in-depth analysesand lengthy documents such as reports. Also, the various means of communication can bemixed: for example, a journalist can insert a video or a picture between two paragraphs oftext. Journalists are expected to work in teams and possess multiple skills, being capable ofproducing writing, videos and images. Furthermore, the abundance of multimedia informationfrom in house archives as well as online repositories allows a journalist to access informationthat makes it easier to author an article and to enrich it with links to other resources and pastarticles, thus meeting the expectations of the reader, who is now used to navigate throughnews items, following links and relations.Audiences expect their news to available when they want to read it and they want the newsto be delivered in the form that is most convenient for them — TV, print, radio, internet, ormobile device. News items have become persistent and global, because once they are publishedon the internet they can be accessed anytime from anywhere.1.2.1 Content in News Markets for Journalists’ TeamsWhen a journalist authors an article for a news page in the internet, he needs to provide thisarticle on a high level of quality and preferably before other news agencies publish the news.The referring to existing content, e.g. existing photographs of an athlete who scored in thegame the article deals with, is an important strategy to integrate existing information in anews article with a minimum of time effort. The search for additional information and relatedcontent is part of the “authoring process” shown in Figure 4.Figure 4: Article authoring processThe journalist is looking for an efficient way of identifying related work and reusing existingcontent, by gathering relevant content items from different sources, such as local contentarchives, the internet, news databases, etc.. According to the different sources, he is workingwith different kinds of content items As shown in Figure 5 the journalist has to handle crossmediacontent items, like videos, photographs, images and texts.© IKS Consortium2010

17 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CasePhotos / ImagesVideosJournalistArticleworks withpublishesTextsFigure 5: Content types in news markets (images from [Pixelio2010])The journalist works primarily with three different groups of content types:1. Photos or images in different formats, sizes and resolutions2. Videos in different formats, like mpeg, avi, wmv, etc.3. Texts on different levels of linguistic quality and in different languagesPhotos or images contain information about persons, events, building or any kinds of entitiesin one specific moment in time, e.g. a football team celebrating the win of a championship.The journalist is interested in identifying the different actors or other entities from the photographwhich could be relevant for the article he is writing. The system should enable him torefer or link to photos dealing with persons or buildings he is writing about and to integratethe photos into his article.The different kinds of relevant entities in videos are similar to the entities on photos or images(persons, buildings, etc.). In addition to the entities shown in a video, different eventsrelated to these entities occur in a specific chronological order. A journalist would not only beinterested, e.g. in a player in a football match, but also in the different situations and eventsin the video. Since videos can differ in length it would be very time-intensive for the journalistto identify relevant parts, so a key-frame based selection of sequences would be helpful.A very popular and distributed kind of content are textual content items. In the news marketdomain, texts can be related articles, descriptions of the topic, books or any other kind ofdocumentation. The textual content can be combined with photos or images.© IKS Consortium2010

18 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case1.2.2 Challenges of Content Management in News MarketsAccording to the relevance of content investigated in the previous section, two challengeshave been derived:1. Extraction of specific information from content items2. Enrichment of content with additional informationIn the following, these challenges are described and domain-specific high-level requirementsare derived for the vertical use case.1.2.2.1 Information Extraction from Content ItemsThe content which is to be analyzed by the journalist can be available in different mediatypes, like photos, images, videos or texts. The task of the journalist is to identify and extractthe relevant information from these content items. An example of a photo from a basketballmatch is given in Figure 6.Player: John DunkingTeam: BasketsFigure 6: Information extraction from photographs [Pixelio2010]The exemplary photograph in Figure 6, shows a scene from a basketball game. A journalist,who is writing an article about this game, may have access to a large repository of such photos.An appropriate content management system should be able to support the journalist byextracting relevant information from the photos to allow an efficient selection and assignmentof the photos. As shown in the example, the identification of the players, e.g. the scorer,could be the goal of the journalist, as he wants to write about this player as the match winner.According to the need of identification of specific entities in cross-media content items, a contentmanagement system for journalists should support recognition algorithms. Through© IKS Consortium2010

19 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Casethese algorithms, information can be extracted from photos, videos or texts. The capability ofextracting information from existing content items is a prerequisite for the efficient selectionand reuse of content for authoring purposes.The main challenge for CMS in the news market is to provide appropriate and customisablerecognition algorithms for cross-media content items. The journalist using the CMS should beable to customise the kind of entities that should be extracted according to the context he isworking in.1.2.2.2 Enrichment of Content with additional InformationThe enrichment of content addresses the need of journalists to gather information for an articlehe is authoring. The automatic enrichment reduces the effort for the investigation andsearching of related content. An example of an enrichment scenario is given in Figure 7 anddescribed in the following.Player Information:Name:Height:Weight:John Dunking6 ft 6 in215 lbPlayer Information:Name: John DunkingTeam: BasketsContentenrichmentTeam: BasketsPosition: Shooting Guard-------------------------------Statistics:Avg. Point: 22,7Rebounds: 5,8Assists: 8,3------------------------------Career History:Baskets 2005 – 2010Pointers 2001 – 2005Figure 7: Exemplary content enrichment in the news market domainA journalist writes an article about a basketball game. The player “John Dunking” was thebest player of the game and the journalist wants to point out him in the article. He has onlythe name of the player and of his team. The content enrichment functionality is able to retrieveadditional and related information about the topic and provides this information to thejournalist. Thereby the journalist is able to use the results to enrich the existing content withthe retrieved information.The content enrichment includes the retrieval of information from different sources and theenrichment of the existing content with the retrieved information. Figure 8 shows a simplified,abstract content enrichment process.© IKS Consortium2010

20 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 8: Content enrichment with additional informationAt first, the journalist creates or selects the content he wants to enrich. In the next step, additionalinformation is retrieved from a defined source, which can be an external source in theinternet or a local CMS or database (see Figure 9). Internal sources can include, e.g. otherarticles written by journalists from the same news agency. After the information is retrieved,the information is added to the existing content.Figure 9: Information retrievalThe quality and quantity of the results is strongly dependent on the retrieval algorithm that isused in the content enrichment and on the available sources. The main challenges in the realizationof the enrichment of content are the development of appropriate retrieval algorithmsand the integration of retrieved information to the existing content.© IKS Consortium2010

21 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case1.3 Portal Market for Travel AgenciesIn this section, the vertical use case of portal market for travel agencies is analysed. The inputfor this domain is given by the company CIC/PISANO, a provider for domain-specific contentmanagement systems for travel agencies. The experiences of CIC/PISANO in domainspecificneeds and requirements from their customers are feed into the general description ofthe tourism domain, the identification of travel agency needs and the derivation of challenges.GeneralIn the tourism market, groups of people are looking to buy tour packages, transportation, hotelor other lodgings, restaurant/bar food, souvenirs, travel insurance, luggage, etc.Tourism covers a value network which includes many sub sectors: accommodation providersfrom five star hotels to bed and breakfasts; restaurants, pubs, bars and catering; museums,arts and heritage attractions, museums & zoos; theme parks, cinemas and sporting facilities;tour operators & ground handlers; coach, bus and taxi companies. The market is segmentedaccording to different interests, e.g. there is also a segment dealing with business-relatedtourism for conferences, meetings and exhibitions.Internet MarketingInternet marketing allows tour operators or travel agencies to react very quickly to fluctuationsin demand and supply – they can change prices, offers, information etc according todemand. All the players in these markets have websites and acknowledge the power of theworld's fastest growing marketing medium. But many still don't really understand (and use)the advantages of the internet.Many web sites provide exactly the same content for all users. Only some of them changetheir scope and information for different types of users. This is interesting since there is increasedawareness in the tourism industry of the need to cater for segmented markets individually.The total market for tourism products is huge. It is made up of people looking for budget accommodationand rooms in exclusive country house hotels, of sun-worshippers and culturevultures,of couch potatoes and ardent adventurers. You can’t hope to satisfy all of the peopleall of the time. Broadcast marketing or trying a ‘something for everyone’ approach is expensiveand rarely successful.It is far more productive and cost-effective to identify several smaller groups of people ormarket segments. Segmentation means breaking markets down into a more manageablesize, and gaining a precise understanding of different groups of people [Tourism Network2010].1.3.1 Travel Agencies Needs on Product PresentationIn this section, the needs of travel agencies are discussed with emphasis on the presentationof their products. As the main purpose of content management in this domain, the customershould be supported in searching products addressing his interests. In addition, an appropriatepresentation of products, e.g. by offering additional and related information, increases thecustomer satisfaction and maximises the profit of the travel agencies. As shown in Figure 10,the product presentation bridges the gap between customer needs and tourism products offeredby travel agencies.© IKS Consortium2010

22 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 10: Customer Needs and Tourism Products1.3.1.1 Cross-Selling of Tourism ProductsThe travel agencies have the economic motivation to sell as many products as possible tothe customer. On the other hand, they are also aiming at a high customer satisfaction in orderto establish a larger customer base. The so called “cross-selling” is an established approachin the tourism domain.“Cross-selling” means that additional products are sold to an existing customer. An examplefor successful cross-selling in the tourism domain could be the combination of hotels andflight tickets. If a customer is looking for a hotel in Rome, the system can also offer a list oflow-priced flights. In addition, tickets for museums or other cultural institutions could also beoffered to the customer. An example is given in Figure 11.Figure 11: Cross-selling with related products [Pixelio2010]The cross-selling approach has advantages for customers and travel agencies. The customergets additional information which could be useful for planning, e.g. his city trip. Furthermorethe travel agency can present additional products to the customer and probablyincrease the number of sold products and the degree of customer satisfaction.© IKS Consortium2010

23 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case1.3.1.2 Customer Support in Product SearchThe support of customers in searching products is an important need of travel agencies. Efficientand personalized search functionalities allow the finding of products satisfying theneeds of customers. Since not all customers have a concrete idea about their destination,hotel or how they would like to travel, the product search should also support indecisive customersin finding matching products.Even customers with concrete ideas about their holiday plans are facing the problem thatthey have to handle a bulk of products and information provided by the travel agencies. Thesystem should provide personalized search operations supporting the customer in findingrelevant content.1.3.2 Challenges of Content Management in the Tourism DomainAccording to the investigated needs of travel agencies for content presentation, described inthe previous section, two main challenges are derived:1. Automatic enrichment of content with additional information2. Personalized assistance of content searchThese challenges are the starting point for the elicitation of the high-level requirements.1.3.2.1 Automatic Enrichment of ContentThe automatic content enrichment in portal markets for travel agencies is different from thecontent enrichment in the news market domain. In the news market domain, the journalist activelyenriches the existing content with additional information. The content enrichment in thisdomain is an automatic enrichment which is not actively triggered by the customer, but by thecorresponding CMS.An abstract, general process of the content enrichment is shown in Figure 12. The customerspecifies a search query for a specific product from the tourism domain. The content managementsystem should search for the required product and based on this result identify relatedproducts and information. The searched product information is enriched with additionalinformation and presented to the customer. Thereby the customer is able to browse throughthe enriched content.Supporting the described process leads to the first challenge for a portal market for travelagencies. It has to provide algorithms that are able to retrieve related information and products.Therefore semantic descriptions of different products must be provided in a format thatcan be processed automatically.The second challenge raised by the automatic enrichment is to ensure the quality of the informationthat is used to enrich content. Therefore a mechanism for the validation of datasources is required. Certificates have to be provided to ensure the required level of trust forthe content enrichment.© IKS Consortium2010

24 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 12: Process of content enrichment with additional information1.3.2.2 Personalized Content Search AssistanceThe support of customers searching for products raises the challenge for personalized contentsearch assistance. This challenge targets at the improving of the searching capabilitiesin three different ways:1. Personalised search with respect to the user interests´2. Question-based search assistant3. Support of natural language search queries© IKS Consortium2010

25 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseThe first challenge of personalizing the search uses the information stored in a user profile tocustomize the search results. The interest or main topics of the customer, defined in his userprofile are used to filter and personalize the search results.The second challenge is question-based search assistance. Thereby, the customer is supportedto find a matching product. Figure 13 shows the general approach of the assistance.Each question can be answered in different ways. According to the selected answers, thenext questions are chosen by the system. Analysing the given answers a list of correspondingproducts is offered to the customers.Question[Answer 1][Answer 2]QuestionQuestion…….…….Question…….Question[Answer 1] [Answer 2] [Answer 1] [Answer 2]ProductProduct Product ProductFigure 13: Question-based search assistanceThe third challenge is to support the processing of natural language search queries. The portalmarket for travel agencies should be able to analyse a search request which is not providedin formal query syntax but in natural language. The semantic meaning of the requestcan be analysed and the search is performed with respect to the query.© IKS Consortium2010

26 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case2 Requirements Specification MethodologyIn this section, the requirements specification process used for the elicitiation anddocumentation of the requirements in the vertical use case are described. At first, the highlevelrequirements dervied from the different domains are summarized. Afterwards therefinement process is defined. We use domain-specifc scenarios to describe the high-levelrequirements. Based on the scenarios, use cases are derived, which are then refined intoconcrete software requirements.2.1 High-level requirementsThe objective of the analysis of the different domains described in section 1 was theidentification of domain-specific business and technological needs from which high-levelrequirements can be derived. The grouping of these needs into high-level requirementsprovides a starting point for the following specification and refinement process. Although thedomains have been analyzed separately, the aggregation to high-level requirements hasshown that even diverse needs from different domains can be summarized in the same highlevelrequirement (HLR-2305: Content Enrichment). HLR-2301: Content clustering (“Software engineering”)HLR-2302: Traceability among content items (“Software engineering”)HLR-2303: Calculation of correlation among content (“Software engineering”)HLR-2304: Information Extraction (“News market for journalists´ teams”)HLR-2305: Content Enrichment (“Portal market for travel agencies”, “News market forjournalists´ teams”) HLR-2306: Personalized content search assistance (“Portal market for travel agencies”)2.2 Requirements refinement processThe requirements specification in this deliverable is structured according to the IEEE-830standard for recommended practice for software requirements specifications [IEEE1998].The requirements specification and elicitation is a successive refinement process. After defininghigh-level requirements, each is refined into use cases and concrete software requirementsas shown in Figure 14.© IKS Consortium2010

27 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 14: Refinement DAG, that emerges from the refinement process [Christ2009]The domain-specific perspective addressed by the vertical use case describes domainspecificscenarios to each high-level requirement. Use cases found in these scenarios canrelate to more than one scenario and can therefore be related to multiple domains. Furthermoreeven the software requirements can be related to more than one domain. The domainspecificrefinement process is shown in Figure 15.Figure 15: Domain-specific requirements refinement© IKS Consortium2010

28 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case2.3 IKS Actor Model for Requirements CaptureThis section gives an overview of the involved actors. An actor is a role that is associatedwith the execution of a use case. Each use case is associated with at least one actor thatdrives the use case. Actors can be human users that interact with the system or technicalactors like a service that performs a use case.Actors can be refined to express that one actor is a specialized role of another actor. Forexample, the actor CMS user is the common super actor for all specialized actors that areCMS users but also have specialized roles like a content consumer or a content creator.Figure 16 gives an overview of all used actors and their relationships.Figure 16: Actors overviewActor Short name Description© IKS Consortium2010

29 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActor Short name DescriptionCMS CMS The CMS actor controls all use cases that are automatically executedinside the traditional CMS system. From the viewpoint of the IKS theCMS actor is technically a consumer that sends queries to the IKS andits services.IKS IKS The IKS actor controls all non user driven use cases that are not part oftraditional CMS systems. As the IKS will be some kind of servicebroker this actor is used for use cases that are not handled by a specificservice.IKS Service IKS Service The IKS consists of different services. All use cases that are handledby a specific service are associated with the IKS service actor.CMSUserContentconsumerNovicecontentconsumerAdvancedcontentconsumerContentcreatorNovicecontentCMS UserConsumerNoviceconsumerAdvancedconsumerCreatorNovicecreatorThe abstract CMS User is the parent actor of all specialised users. Soeach use case that is associated with the abstract CMS User can beexecuted by any specialised actor which uses features of either CMS orIKS. It may be one of Consumers, Managers or Creators.If no specific content consumer is considered we use this more abstractConsumer actor. The abstract Consumer is the parent actor of allspecialised consumers. So each use case that is associated with theabstract Consumer can be executed by any specialised consumer actor.A content consumer does not create content of any kind - a consumer israther a read only user of the system. For example, a content consumercan be a web site visitor who reads the content published by the CMSor an intranet user who has read access to the content of the intranetCMS. Consumers typically have only access to the front end of theCMS with all features for searching, viewing and reading content.A novice content consumer is a consumer with little or no deeperknowledge about underlying technologies or special features of thesystem. It is that kind of user that only wants to use the system quickwithout a longer learning phase, e.g. first time consumers. By the timethey learn more about the system's features and use them as advancedconsumers.An advanced content consumer has often used the system for a longerperiod of time and knows all or many of the advanced features thatallows him to do his work more efficient. A novice consumer incontrast might not be able to do the same task in the same time andquality as an advanced consumer especially when the task is complexand requires the usage of features that cannot be known by a noviceconsumer.When a content consumer is able to create content in some situationsthe consumer becomes a content creator for those use cases. By contentcreation we mean the process of creating something that is stored in thesystem and that can be (re)used by other actors.Typically content creators have access to the back end of the CMSwhere they have all features for content creation.The novice creator is the greenhorn-backend-user of a CMS, who usesonly the basic functionality of the CMS backend and needs often help© IKS Consortium2010

30 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActor Short name DescriptioncreatorAdvancedcontentcreatorContentmanagerAdvancedcreatorManagerand advise. On the other hand the novice content creator creates mostcontent elements withouht beeing responsible for the content.The advanced creator is the power-backend-user of a CMS, who usesall functionalities of the CMS backend. This actor manages products,articles, news, and publishes the content.The content manager is the super user for content consumption andcreation. The manager knows the CMS in detail and is able toconfigure and manage the workflows within the CMS.Administrator AdminThe CMS administrator configures and maintains the CMS and theintegrated IKS services. The admin is the power user who configuresthe used IKS services inside the CMS.Developer Developer All use cases that handle development or integration tasks areassociacted with some developer actor.IKSDeveloperCMSDeveloperIKSCustomizerIKS servicecustomizerIKSDeveloperCMSDeveloperIKSCustomizerServiceCustomizerThe IKS developer is an architect, designer or programmer of IKS corefunctionalities.A CMS developer is an architect, designer or programmer of a CMS.CMS programmers can customize the IKS as they are specialized IKScustomizers and specialized service customizers.The IKS customizer is an architect, designer or programmer that is ableto customize the IKS, e.g. implement a new semantic service using theIKS infrastructure. The customizer does not implement or change thecore of the IKS.An IKS service customizer customizes existing IKS services, e.g. byusing defined extension points of an IKS service.© IKS Consortium2010

31 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case3 High Level RequirementsIn this section, the high-level requirements of the industrial vertical use case are described.According to the requirements specification methodology described in section 2 the highlevelrequirements are described by scenarios from the different domains and refined intouse cases and concrete IKS requirements.In the domains “Software engineering”, “Portal market for travel agencies” and “News marketfor journalists´ teams” the following high-level requirements have been identified:HLR-2301: Content clustering (“Software engineering”)HLR-2302: Traceability among content items (“Software engineering”)HLR-2303: Calculation of correlation among content (“Software engineering”)HLR-2304: Information Extraction (“News market for journalists´ teams”)HLR-2305: Content Enrichment (“Portal market for travel agencies”, “News market forjournalists´ teams”) HLR-2306: Personalized content search assistance (“Portal market for travel agencies”)3.1 HLR-2301: Content clusteringHLR IDNameDescriptionClassificationDomainsHLR-2301Content clusteringIn order to be able to handle different kinds of unstructured and structureddata, the IKS should provide the (semi-)automatic clustering ofcontent.VerticalSoftware engineering (Clustering & Annotation),Relatedrequirements3.1.1 ScenariosScenario 1 (Automatic flat clustering):The software architect in a large software project tries to get an overview about the complexityof the given requirements specification by structuring them in different categories. The requirementsspecification is stored in a CMS. In order to cluster and categorize the content oflarge requirements specification, a service should be available that allows the automatic clus-© IKS Consortium2010

32 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Casetering and the automatic labelling of the generated clusters (e.g. “GUI requirements”, “Userrequirements”).Figure 17: Use case diagram for HLR-2301 scenario 1Scenario 2 (Defining clustering rule set):After processing as described in scenario 1 the clustering does not result in the categoriesdesired by the software architect. Therefore the IKS should provide an editor to define rulesfor the (semi-) automatic clustering service. By the semantics of the content items the clusteringshould be controlled by the specified rule set.© IKS Consortium2010

33 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 18: Use case diagram for HLR-2301 scenario 2Scenario 3 (Automatic hierarchical clustering)After using the flat clustering, the software architect would like to cluster the requirements ina hierarchy to expose the dependencies among them. Therefore he calls a service providingthe automatic hierarchical clustering.© IKS Consortium2010

34 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 19: Use case diagram for HLR-2301 scenario 3Scenario 4 (Semi-automatic assignment to existing clusters):A requirements engineer is documenting the elicited requirements in the software engineeringCMS. While creating the content the system proposes adequate clusters with respect tothe semantics of the content. The requirements engineer is now able to easily choose amongthe different alternatives to assign the requirements to an existing content cluster.© IKS Consortium2010

35 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 20: Use case diagram for HLR-2301 scenario 43.1.2 Use Case DescriptionsUC-230101: Send IKS service request [SC1, SC2, SC3]UC-230102: Define scope [SC1, SC2, SC3]UC-230103: Flat clustering [SC1, SC2]UC-230104: Hierarchical Clustering [SC3]UC-230105: Create content [SC4]UC-230106: Assign content to existing cluster [SC4]UC-230107: Define clustering rules [SC2]UC-230108: Parameterise labelling methodology [SC1, SC3]UC-230109: Parameterised clustering [SC2]UC-230110: Present clustering results [SC1, SC3]UC-230111: Execute [SC1, SC2, SC3]UC-230112: Perform clustering [SC1, SC2, SC3]UC-230113: Build flat content clusters [SC1, SC2]UC-230114: Labelling content clusters [SC1]UC-230115: Cluster-internal labelling [SC1]UC-230116: Differential cluster labelling [SC1]UC-230117: Calculate distance measure between content items [SC1, SC2]UC-230118: Parameterise hierarchical clustering algorithm [SC3]UC-230119: Clustering by defined rule set [SC2]© IKS Consortium2010

36 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230120: Build hierarchical content clusters [SC3]UC-230121: Process hierarchical clustering algorithm [SC3]UC-230122: Divisive algorithm (top-down) [SC3]UC-230123: Agglomerative algorithm (bottom-up) [SC3]UC-230124: Calculate matching to existing clusters [SC4]UC-230125: Suggest matching clusters [SC4]UC-230101: Send IKS service requestUse Case ID UC-230101: Send IKS service request [SC1, SC2, SC3]Description A CMS sends service requests to a semantic service inside the IKS.Parent ---Extensions ---Includes ---Scope Service invocationActor(s) CMSGoal The specified IKS service is invoked.Trigger A CMS service request.Preconditions1. The IKS is ready to receive service requests.Minimal Postconditions1. The IKS sends a response back to the CMS.Success Postconditions1. The specified IKS service is invoked and the results are sent back in the response.Exceptions1. The IKS service gateway is offline and not able to receive service requests.UC-230102: Define scopeUse Case ID UC-230102: Define scope [SC1, SC2, SC3]Description The consumer defines the scope of the content which he would like to beclustered. All content items in this scope are considered by the clustering© IKS Consortium2010

37 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---Includes ---algorithms.Scope Scoping clusteringActor(s) ConsumerGoal The relevant content for the clustering is scoped.Trigger The consumer wants to start the content clustering and therefore defines thescope.Preconditions1. The consumer is able to access the content.Minimal Postconditions1. The consumer gets a notification whether the scope have been defined successfully.Success Postconditions1. The consumer has successfully defined the scope and exactly matches the contenthe intended to be clustered.Main Flow1. The consumer uses browsing and searching capabilities to identify the relevantcontent.2. The consumer selects the content for the scope of the clustering functionality.3. The scope including the selected content items is definedExceptions1. The existing content can not be accessed and selected from the content databasebecause the data access service is not available.UC-230103: Flat clustering [SC1, SC2]Use Case ID UC-230103: Flat clustering [SC1, SC2]Description The consumer starts the flat clustering, i.e. a request is sent to the IKS andhandled by the clustering engine.Parent ---© IKS Consortium2010

38 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExtensions Parametrization: UC-230109Includes UC-230112, UC-230102Scope Flat clusteringActor(s) ConsumerGoal The content is clustered.Trigger The consumer performs the flat clustering.Preconditions1. Existing content which can be clustered.Minimal Postconditions1. The consumer is informed about the status of the request.Success PostconditionsExceptions1. The flat clustering request is processed successfully.1. The content to be clustered cannot be accessed or no content exists.2. The scope has not been defined3. The corresponding clustering service is not available.© IKS Consortium2010

39 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 21: Activity diagram for use case UC-230103UC-230104: Hierarchical Clustering© IKS Consortium2010

40 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230104: Hierarchical Clustering [SC3]Description The consumer requests the hierarchical clustering, i.e. a request is sent to theIKS and handled by the clustering engine.Parent ---Extensions ---Includes UC-230112, UC-230102Scope ClusteringActor(s) ConsumerGoal The hierarchical clustering is executed.Trigger The consumer starts the hierarchical clustering.Preconditions1. Existing content which can be clustered.Minimal Postconditions1. The consumer is informed about the status of the request.Success PostconditionsExceptions1. The flat clustering request is processed successfully.1. The content to be clustered cannot be accessed or no content exists.2. The scope has not been defined3. The corresponding clustering service is not available.© IKS Consortium2010

41 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 22: Activity diagram for use case UC-230104UC-230105: Create contentUse Case ID UC-230105: Create content [SC4]Description The consumer is creating new content. Afterwards the consumer can use theauto-suggestion for assigning the content to an existing content cluster.Parent ---Extensions ---© IKS Consortium2010

42 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseIncludes ---Scope Creation of contentActor(s) ConsumerGoal The creation of content by the consumer.Trigger The consumer creates new content.Preconditions1. ---Minimal Postconditions1. The consumer is informed about the status of the content creation.Success Postconditions1. The content is created successfully and the consumer is notified of the creation.Mainflow1. Open the editor for content creation.2. Create content in the CMS.3. Store content in the CMS.Exceptions1. The content creation and storing service is not available.UC-230106: Assign content to existing clusterUse Case ID UC-230106: Assign content to existing cluster [SC4]Description The consumer created new content in a context with existing clusters. In orderto assign the new content to an existing cluster, the user can simply add thecontent or he can use the auto-suggestion functionality which provides a list ofmatching clusters.Parent ---Extensions Auto-suggestion: UC-230125Includes UC-230105Scope Assigning to existing clustersActor(s) ConsumerGoal The content is semi-automatically assigned to an existing cluster.© IKS Consortium2010

43 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseTrigger The consumer creates or edits content and chooses the auto-suggestion forthe assignment of the content to an existing cluster.Preconditions1. The consumer created content which has not been assigned to an existing cluster.2. At least one content cluster has already been created.Minimal Postconditions1. The consumer is informed about the status of the assignment.Success PostconditionsExceptions1. The consumer adds the content to an existing cluster.2. The consumer gets an auto-suggestion with existing clusters matching the currentcontent and adds the content to an existing cluster.1. Existing content clusters can not be accessed.2. Auto-suggestion service is not available.© IKS Consortium2010

44 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 23: Activity diagram for use case UC-230107UC-230107: Define clustering rulesUse Case ID UC-230107: Define clustering rules [SC2]Description The advanced consumer is able to define a set of rules which should be usedfor the clustering of content.Parent ---© IKS Consortium2010

45 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExtensions ---Includes ---Scope Parametrized clusteringActor(s) Advanced consumerGoal Defining a ruleset for the clustering of content.Trigger The advanced consumer requires a ruleset providing a specific “kind” ofclustering.Preconditions1. ---Minimal Postconditions1. The advanced consumer is informed about the status of the rule definition.Success Postconditions1. The advanced consumer successfully creates a clustering rule set.UC-230108: Parameterise labelling methodologyUse Case ID UC-230108: Parameterise labelling methodology [SC1, SC3]Description The labelling of content clusters can be done by two different approaches.Specifying which approach should be used, an advanced consumer cancustomize the methodology to use.Parent ---Extensions ---Includes ---Scope Labelling clustersActor(s) Advanced consumerGoal Defining the methodoloy for labelling clusters.Trigger The advanced consumer wants to parameterise a specific methodology.UC-230109: Parameterised clustering© IKS Consortium2010

46 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230109: Parameterised clustering [SC2]Description The flat clustering is extended by the .possibility to use a predefined set ofrules for the clustering.Parent ---Extensions ---Includes UC-230107Scope ClusteringActor(s) Advanced consumerGoal The flat clustering is processed with respect to the defined rules.Trigger The advanced consumerPreconditions1. Rules for parameterisation have been defined.2. The content to be clustered is available.Minimal Postconditions1. The consumer is informed about the status of the request.Success Postconditions1. The parameterised clustering request is processed successfully.Main Flow1. Definition of a clustering rule set for the parameterisation.2. Send the service request for parameterised flat clustering.Exceptions1. The content to be clustered cannot be accessed or no content exists.2. The scope has not been defined3. The corresponding clustering service is not available.UC-230110: Present clustering resultsUse Case ID UC-230110: Present clustering results [SC1, SC3]Description The IKS should be able to present the results of the clustering in anappropriate format. Since the presentation of the clustering results can also behandled by the CMS, the IKS service is an optional extension of the clustering.© IKS Consortium2010

47 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---Includes ---Scope Presentation of clusteringActor(s) IKSGoal Presentation of the clustering results in an appriopriate form.Trigger The clustering service is requested and the optional presentation of clusteringresults is activated.UC-230111: ExecuteUse Case ID UC-230111: Execute [SC1, SC2, SC3]Description When a service is invoked by the IKS it starts its execution. Each service isable to call back the CMS, load additional content, store data, and must beaware of existing execution time constraints.Parent ---Extensions ---Includes ---Scope Service execution.Actor(s) IKS ServiceGoal Execute the service and compute a result.Trigger The service was invoked.UC-230112: Perform clusteringUse Case ID UC-230112: Perform clustering [SC1, SC2, SC3]Description The clustering functionality is provided by executing an IKS service.Parent UC-230111 ExecuteExtensions Presentation of results: UC-230110Flat clustering: UC-230113Hierarchical clustering: UC-230120© IKS Consortium2010

48 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseIncludes UC-230103UC-230104Scope ClusteringActor(s) IKS ServiceGoal The clustering is performed and the content is structured in clusters.Trigger A consumer starts the clustering and the corresponding IKS service is called.UC-230113: Build flat content clustersUse Case ID UC-230113: Build flat content clusters [SC1, SC2]Description The building of flat content clusters is an extension of the performing ofclustering. Flat content clusters do not reflect any kind of hierarchy among thedifferent clusters. On the other hand, they are easier to calulate and thereforeprefereable, when no hierarchy is required. The main tasks are the calculationof useful clusters and the appropriate labelling of them, corresponding to theclustered content.Parent -Extensions -Includes UC-230114UC-230117Scope Flat clusteringActor(s) IKS ServiceGoal Building of flat content clusters.Trigger The IKS clustering service is called and a flat clustering is requested.Preconditions1. ---Minimal Postconditions1. The service provides a response about the operations done.Success PostconditionsMain Flow1. The service provides the calculated flat clusters.1. Calculate the distance measure between content items to identify related content.© IKS Consortium2010

49 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExceptions2. Aggregate related content to clusters.3. Label content clusters (cluster-internal or differential cluster labelling)1. The clustering service is not available.2. No appropriate relations between the content items can be calculated.UC-230114: Labelling content clusters [SC1]Use Case ID UC-230114: Labelling content clusters [SC1]Description The created clusters have to be labeled with an appropriate name, to describethe kinds of content that are aggregated in this clustered. The labelling can berealized by two different approaches: “Cluster-internal labelling” and“Differential cluster labelling”.Parent ---Extensions ---Includes ---Scope Labelling of clustersActor(s) IKS ServiceGoal Labelling content clustersTrigger The consumer triggered the clustering and the IKS clustering service createdone or more content clusters.Preconditions1. ---Minimal Postconditions1. The service provides a response about the operations done.Success Postconditions1. The clusters have been labeled successfully.© IKS Consortium2010

50 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 24: Activity diagram for use case UC-230114UC-230115: Cluster-internal labellingUse Case ID UC-230115: Cluster-internal labelling [SC1]© IKS Consortium2010

51 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseDescription The labelling of clusters can be done by different approaches. The “clusterinternal”approach analyses the content aggregated in the cluster and extractsan appropriate label. The labelling is therefore independent from other clusters.Parent UC-230114Extensions ---Includes ---Scope Labelling of clustersActor(s) IKS ServiceMain FlowGoal The clusters are labeled following the cluster-internal approach.Trigger The IKS labelling service is performed and the cluster-interal labelling isrequested.1. The content of each cluster is analyzed separately.2. Based on the content an appropriate label for each cluster is derived.3. The content cluster is labelled.UC-230116: Differential cluster labelling [SC1]Use Case ID UC-230116: Differential cluster labelling [SC1]Description The labelling of clusters can be done by different approaches. The “differentialcluster” approach analyses not only the content aggregated in the cluster butalso compares it to the content in other clusters. Therefore differentiates toother clusters are considered in the labelling. In comparison to the “clusterinternal”approach the algorithm is more complex.Parent UC-230114Extensions ---Includes ---Scope Labelling of clustersActor(s) IKS ServiceGoal The clusters are labeled following the differential cluster labelling.Trigger The IKS labelling service is performed and the differential cluster labelling isrequested.© IKS Consortium2010

52 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseMain Flow1. The content of one cluster is analyzed in comparison to content in other clusters.2. Based on the content an appropriate label for each cluster is derived.3. The content cluster is labelled.UC-230117: Calculate distance measure between content itemsUse Case ID UC-230117: Calculate distance measure between content items [SC1, SC2]Description To identify possible clusters, the similarity among content items is calculated..The identification of similar or related content is done by the calculation of thedistance measure between them.Parent ---Extensions UC-230119Includes ---Scope Flat clusteringActor(s) IKS ServiceGoal Calculate the distance measeure between the content items to identify usefulclusters.Trigger The flat clustering service is performed, which calls the the distance measurecalculation.UC-230118: Parameterise hierarchical clustering algorithmUse Case ID UC-230118: Parameterise hierarchical clustering algorithm [SC3]Description The hierarchical clustering processed by two different kinds of algorithms.Specifying which approach should be used, an advanced consumer cancustomize the kind of algorithms to use for the building of hierarchical contentclusters.Parent ---Extensions ---Includes ---Scope Hierarchical clusteringActor(s) Advanced consumerGoal Parameterise the algorithm for hierarchical clustering.© IKS Consortium2010

53 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseTrigger The advanced consumer wants to parameterise the algorithm for hierarchicalclustering.UC-230119: Clustering by defined rule setUse Case ID UC-230119: Clustering by defined rule set [SC2]Description As an extension to the calculation of the distance measure it should bepossible to influence this calculation by a predefined rule set. This rule set isconfigured by an advanced consumer.Parent ---Extensions ---Includes ---Scope Parameterised clusteringActor(s) IKS ServiceGoal Providing the clustering regarding a defined rule set.Trigger The distance measure is calculated between content items and a rule set forthe clustering is predefined by an advanced consumer.UC-230120: Build hierarchical content clustersUse Case ID UC-230120: Build hierarchical content clusters [SC3]Description The building of hierarchical content clusters is an extension of the performingof clustering. Hierachical content clusters reflect the relations anddependencies among the clusters by categorizing them in a hierarchy. Themain challenges are the calculation of useful clusters and the appropriatelabelling of them, corresponding to the clustered content.Parent ---Extensions ---Includes UC-230114UC-230121Scope Hierarchical clusteringActor(s) IKS ServiceGoal The content is aggregated in clusters which are classified in a hierarchy.© IKS Consortium2010

54 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseTrigger The IKS clustering service is performed and a hierarchical clustering isrequested.Preconditions1. ---Minimal Postconditions1. The service provides a status response.Success PostconditionsMain Flow1. The service provides the calculated flat clusters.1. Process hierarchical clustering algorithm (parameterisation “top-down”, “bottomup”).2. Label content clusters (cluster-internal or differential cluster labelling).UC-230121: Process hierarchical clustering algorithmUse Case ID UC-230121: Process hierarchical clustering algorithm [SC3]Description The calculation of hierarchical clusters is more complex than flat flat clusters.Two different kinds of algorithms can be used for this calculation: “Top-Down”and “Bottom-Up”. These algorithms have two objectives. On the one handclusters have to calculated according to the content and these clusters have tobe related to each other in a hierarchy of clusters.Parent ---Extensions ---Includes ---Scope Hierarchical clusteringActor(s) IKS ServiceGoal Calculation of content clusters and hierarchies by corresponding algorithms.Trigger The hierarchical clustering service is executed.Exceptions1.Action© IKS Consortium2010

55 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 25: Activity diagram for use case UC-230121UC-230122: Divisive algorithm (top-down)© IKS Consortium2010

56 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230122: Divisive algorithm (top-down) [SC3]Description The divisive algorithms for hierarchical requirements are following a top-downmethodology. The clustering starts at the root and iteratively refine into otherclusters (opposite: agglomerative algorithms).Parent UC-230121Extensions ---Includes ---Scope Hierarchical clusteringActor(s) IKS ServiceGoal Support of the hierarchical clustering by divisive algorithms.Trigger Performing the hierarchical clustering service.UC-230123: Agglomerative algorithm (bottom-up)Use Case ID UC-230123: Agglomerative algorithm (bottom-up) [SC3]Description In contrast to the top-down approach of the divisive algorithms, the bottom-upapproach starts at the leaves of the hierarchy (content items) and successivelymerge these items to larger clusters.Parent UC-230121Extensions ---Includes ---Scope Hierarchical clusteringActor(s) IKS ServiceGoal Support of the hierarchical clustering by agglomerative algorithms.Trigger Performing the hierarchical clustering service.UC-230124: Calculate matching to existing clustersUse Case ID UC-230124: Calculate matching to existing clusters [SC4]Description Based on a set of existing clusters in a defined scope, a IKS service should beable to calculate the matching of new content to the existing clusters.© IKS Consortium2010

57 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---Includes ---Scope Parametrised clusteringActor(s) IKS ServiceGoal The matching of new content to existing clusters is calculated.Trigger The auto-suggestion is requested by the consumer to assign content to anexisting cluster.UC-230125: Suggest matching clustersUse Case ID UC-230125: Suggest matching clusters [SC4]Description The suggestion of matching clusters is an optional extension for theassignment of content to existing clusters. By this functionality the consumershould be supported using an auto-suggestion to identify appropriate clustersto which the created content could be assigned.Parent ---Extensions ---Includes UC-230124Scope Parametrised clusteringActor(s) IKS ServiceMain FlowGoal Provide a ranked suggestion to the consumer for the assignment of content toexisting clusters.Trigger The auto-suggestion is requested by the consumer to assign content to anexisting cluster.1. Calculate matching to existing clusters.2. Build ranked list of matching clusters.3. Provide auto-suggestion of matching clusters.© IKS Consortium2010

58 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case3.1.3 Resulting Requirements DescriptionFunctional RequirementsID Requirement UC-RefFR-230101 The IKS shall support the definition of scopes of relevant content for theclustering.FR-230102 The IKS shall be able to assign created content to an existing contentcluster.FR-230103 The clustering rules used by the IKS shall be configurable.FR-230104 The labeling methodology used by IKS shall be parameterisable.FR-230105 The flat clustering performed by the IKS shall be customizable.FR-230106 The IKS shall be able to present the results of the clustering.FR-230107 The IKS shall be able to build flat content clusters.FR-230107 The IKS shall be able to label content clusters.FR-230108 The IKS shall support cluster-internal labelling.FR-230109 The IKS shall support differential cluster labelling.FR-230110 The IKS shall be able to calculate the distance measure between contentitems.FR-230111 The hierarchical clustering algorithm processed by the IKS shall becustomizable.FR-230112 The IKS shall be able to build hierarchical content clusters.FR-230113 The IKS shall be able to process hierarchical clustering algorithms.FR-230114 The IKS shall support divisive clustering algorithms.FR-230115 The IKS shall support agglomerative clustering algorithms.FR-230116 The IKS shall be able to calculate the matching to existing clusters.FR-230117 The IKS shall be able to suggest matching clusters to created content.UC-230102UC-230105UC-230107UC-230108UC-230109UC-230119UC-230110UC-230113UC-230114UC-230115UC-230116UC-230117UC-230118UC-230120UC-230121UC-230122UC-230123UC-230124UC-230125FR-230118 The IKS clustering shall be performed by processing the clustering features. UC-230112Data requirementsID Requirement UC-RefDR-230101 The IKS shall be able to handle a service request and to send back aresponse.UC-230201Integration requirementsID Requirement UC-RefINR-230101 The automatic labelling of content clusters shall be customizable byparameterising custom labelling strategies.INR-230102 The automatic flat clustering shall be customizable by implementing customclustering strategies.UC-230208UC-230209© IKS Consortium2010

59 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement UC-RefINR-230103 The automatic hierachical clustering shall be customizable by implementingcustom clustering strategies.UC-230218Interface requirementsID Requirement UC-RefIR-230101 The IKS shall be able to process defined content scopes.IR-230102 The IKS shall be able to process clustering rules.IR-230103 The IKS shall be able to process labelling parameter.IR-230104 The IKS shall be able to process created content.UC-230102UC-230107UC-230108UC-230105Non functional requirementsID Requirement UC-RefNFR-230101 The IKS flat clustering shall be a semantic service.NFR-220102 The IKS hierarchical clustering shall be a semantic service.UC-230103UC-230104© IKS Consortium2010

60 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case3.2 HLR-2302: Traceability among content itemsHLR IDNameDescriptionClassificationDomainsHLR-2302Traceability among content itemsTo allow an efficient change and consistency management IKS shouldprovide the automatic creation of relations among content items ofsame or different types. The different kinds of relations and rules forthe definition of relations should be specifiable by the user. ThereforeIKS has to provide editors and pattern repositories for the definition ofsuch relation types and rule sets.VerticalSoftware engineering (Traceability)Relatedrequirements3.2.1 ScenariosScenario 1 (Automatic creation of horizontal links):The software engineer has elicited and documented a set of software requirements (textualdescription) in a CMS for software engineering artefacts. Managing the relations and dependencies,IKS should provide a service to automatically create links between the differentrequirements. The links should be typed to specify the kinds of relation between the requirements.© IKS Consortium2010

61 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 26: Use case diagram for HLR-2302 scenario 1© IKS Consortium2010

62 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseScenario 2 (Automatic creation of vertical links):The manager of a software project revises the project documentation. Requirements specificationand design artefacts (e.g. class diagrams, textual description of architectural design,...) are stored in a CMS for software engineering artefacts. The links between cross-type contentitems should be created automatically.© IKS Consortium2010

63 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 27: Use case diagram for HLR-2302 scenario 2Scenario 3 (Auto-suggestion for semi-automatic creation of links):© IKS Consortium2010

64 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseAccording to scenario 1 and 2, links between content items have been defined. With respectto changing business needs, new requirements came up and should be documented in theCMS. While creating or editing a requirement, the system should suggest links to other itemsalready stored in the system.Figure 28: Use case diagram for HLR-2302 scenario 3Scenario 4 (Customization of linking rules):The software architect would like to configure the linking between requirements and designartefacts. Thus, he uses the editor to define rules for the creation of these links and storesthem in the rule repository.© IKS Consortium2010

65 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 29: Use case diagram for HLR-2302 scenario 4Scenario 5 (Customized creation of links):After defining linking rules (scenario 3) the software architect performs the automatic linkingfunctionality. Customized by the defined rules content items are linked to each other as intendedby the architect.© IKS Consortium2010

66 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 30: Use case diagram for HLR-2302 scenario 53.2.2 Use Case DescriptionsUC-230201: Store horizontal links between content items [SC1]UC-230202: Store vertical links between content items [SC2]UC-230203: Load linking rules from repository [SC4]UC-230204: Store linking rules in repository [SC4]UC-230205: Set suggested link [SC3]UC-230206: Automatic linking [SC1, SC2, SC5]UC-230207: Access linking rules in the repository [SC4]UC-230208: Edit existing content [SC3]UC-230209: Auto-suggestion [SC3]UC-230210: Set linking rule for automatic creation [SC5]UC-230211: Define linking rules [SC4]UC-230212: Create linking rules [SC4]© IKS Consortium2010

67 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230213: Edit linking rules [SC4]UC-230214: Provide results in a reusable format [SC1, SC2]UC-230215: Interpret defined linking rules [SC5]UC-230216: Identify type of link [SC1, SC2]UC-230217: Perform automatic creation of links [SC1, SC2, SC5]UC-230218: Perform automatic creation of horizontal links [SC1]UC-230219: Perform automatic creation of vertical links [SC2]UC-230220: Set links between content items [SC1, SC2]UC-230221: Analyze relations between content items [SC1, SC2]UC-230222: Analyze textual content items [SC1, SC2]UC-230223: Analyze non-textual content items [SC2]UC-230224: Suggest links to existing content items [SC3]UC-230225: Customize creation of links by linking rules [SC5]Use cases from other HLRs UC-230101: Send IKS service request [SC1, SC2, SC5] UC-230105: Create content [SC1, SC3]UC-230201: Store horizontal links between content itemsUse Case ID UC-230201: Store horizontal links between content items [SC1]Description The links defined between content of same type (horizontal links) are stored inthe repository. This repository should be stored in the local database of theCMS.Parent ---Extensions ---Includes ---Scope Horizontal linkingActor(s) CMSGoal Storing of horizontal links.Trigger The consumer triggers the storing of defined links.Preconditions1. Horizontal links between content items have been defined.Minimal Postconditions1. The service gives a status response to the user.Success Postconditions1. The links are successfully stored in the repository.© IKS Consortium2010

68 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExceptions1. The service is not available and the horizontal links can not be stored.UC-230202: Store vertical links between content itemsUse Case ID UC-230202: Store vertical links between content items [SC2]Description The links defined between cross-type content (vertical links) are stored in therepository. This repository should be stored in the local database of the CMS.Parent ---Extensions ---Includes ---Scope Vertical linkingActor(s) CMSGoal Storing of vertical links.Trigger The consumer triggers the storing of defined links.Preconditions1. Vertical links between content items have been defined.Minimal Postconditions1. The service gives a status response to the user.Success Postconditions1. The links are successfully stored in the repository.Exceptions1. The service is not available and the vertical links can not be stored.UC-230203: Load linking rules from repositoryUse Case ID UC-230203: Load linking rules from repository [SC4]Description In order to reuse defined linking rules, it should be possible to load linking rulesfrom the repository. These linking rules are stored locally in the CMS.Parent ---© IKS Consortium2010

69 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExtensions ---Includes ---Scope Persistence of linking rulesActor(s) CMSGoal Loading of linking rules from the repository.Trigger The consumer wants to access linking rules from the repository.Preconditions1. Linking rules have been defined and stored in the repository.2. The consumer has required access rights to load rules from the repository.Minimal Postconditions1. The service provides a response message about the status of the loading process.Success Postconditions1. The linking rules are loaded successfully from the repositoryMain Flow1. Request loading of linking rules from repository.2. Check access rights of user.3. Load linking rules from repository.4. Provide results to the user.Exceptions1. The persistency / loading service is not available.2. The repository is not available.3. No linking rules have been stored in the repository.UC-230204: Store linking rules in repositoryUse Case ID UC-230204: Store linking rules in repository [SC4]Description In order to reuse defined linking rules, it should be possible to store created oredited linkning rules in the repository. These linking rules are persisted locallyin the CMS and could be load by the consumer.Parent ---Extensions ---Includes ---© IKS Consortium2010

70 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseScope Persistence of linking rules.Actor(s) CMSGoal Storing linking rules in the repository.Trigger The consumer stores linking rules in the repository.Preconditions1. Linking rules have been defined.2. The consumer has required access rights to store rules in the repository.Minimal Postconditions1. The service provides a response message about the status of the storing process.Success Postconditions1. The linking rules are stored successfully in the repositoryMain Flow1. Request storing of linking rules in the repository.2. Check access rights of user.3. Storing linking rules in the repository.4. Provide notification to the user.Exceptions1. The persistency / storing service is not available.2. The repository is not available.UC-230205: Set suggested link [SC3]Use Case ID UC-230205: Set suggested link [SC3]Description After requesting the auto-suggestion for links to existing content items, thesuggested links are presented to the consumer. Working on these results, theconsumer selects the most appropriate links to reflect the relation among thedifferent content items.Parent ---Extensions ---Includes UC-230224Scope Linking rulesActor(s) ConsumerGoal The consumer sets a link suggested by the corresponding IKS service.© IKS Consortium2010

71 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionTrigger The consumer requested the auto-suggestion and gets the suggested linksdisplayed for selection.Figure 31: Activity diagram for use case UC-230205UC-230206: Automatic linkingUse Case ID UC-230206: Automatic linking [SC1, SC2, SC5]© IKS Consortium2010

72 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseDescription The automatic creation of links between content items is the main functionalityfor providing traceability among them. Two different kind of links are separatedfrom each other. Horizontal links are created between content items of thesame description level whereas vertical links define relations between contentitems on different levels.Example: In the software engineering domain the creation of horizontal links isused to specify relations between requirement descriptions. On the other handvertical links could be used to connect requirements with design items (e.g.component diagrams or descriptions).Parent UC-230111Extensions ---Includes UC-230217Scope Automatic linkingActor(s) ConsumerGoal Automatic creation of links between content items.Trigger The user requests the automatic linking service.Preconditions1. The different content items must be accessible.2. The corresponding IKS linking service must be available.Minimal Postconditions1. The service provides a status response to the user.Success Postconditions1. The links between the content items (vertical and horizontal) are created.Exceptions1. The IKS auto-linking service is not available.Action© IKS Consortium2010

73 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 32: Activity diagram for use case UC-230206UC-230207: Access linking rules in the repositoryUse Case ID UC-230207: Access linking rules in the repository [SC4]Description In order to be able to reuse defined linking rules, the advanced consumer isable to access a rule repository. In this repository he can store defined rules orload rules for editing.Parent ---Extensions Load rules: UC-230203Store rules: UC-230204Includes ---Scope Linking rulesActor(s) Advanced consumerGoal The advanced user can access linking rules in the repository.© IKS Consortium2010

74 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseTrigger The access is triggered by the advanced consumer in order to store linkingrules in the repository or load rules for editing.Exceptions1. The repository or the corresponding service is not available.2. The advanced consumer does not have the required access rightsActionFigure 33: Activity diagram for use case UC-230207UC-230208: Edit existing contentUse Case ID UC-230208: Edit existing content [SC3]© IKS Consortium2010

75 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseDescription The consumer edits an existing content item. In the software engineeringdomain this could be a change of a requirement description with respect toevolving business needsParent ---Extensions ---Includes ---Scope Content handlingActor(s) ConsumerGoal The content item is successfully edited according to the changes done by theconsumer.Trigger The consumer edits an existing content item addressing a change in the “realworld”.Preconditions1. The content item to be changed already exists in the CMS.Minimal Postconditions1. The service provides a status response to the user.Success Postconditions1. The content is changed by the consumer and stored in the system.Main Flow1. Select content item for editing.2. Edit content item.3. Store changed content in the CMS.Exceptions1. The content editor is not available.2. The content item can not changeda. Missing access rights of the userb. The content item is blocked by another user3. The edited content item can not be stored in the CMSa. The storing service is not availableUC-230209: Auto-suggestionUse Case ID UC-230209: Auto-suggestion [SC3]Description In some cases the automatic creation might not be appropriated. Therefore theauto-suggestion provides the required functionality for the semi-automatic© IKS Consortium2010

76 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---creation of links. After creating or editing a content item, the consumer canrequest an auto-suggestion providing links to other content items. By applyingthese suggestions the consumer can create the links.Includes UC-230224Scope Suggestion of linksActor(s) ConsumerGoal Appropriate links to other content item are suggested to the consumer.Trigger The consumer triggers the auto-suggestion.Preconditions1. The content item for which links should be suggested is available.Minimal Postconditions1. The service provides a status response to the user.Success PostconditionsAction1. An auto-suggestion of appropriate links is provided to the consumer.© IKS Consortium2010

77 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 34: Activity diagram for use case UC-230209UC-230210: Set linking rule for automatic creationUse Case ID UC-230210: Set linking rule for automatic creation [SC5]Description The rules for linking itself are defined by an advanced consumer. Based on aset of linking rules the consumer can choose the appropriate rules forperforming the automatic linking.Parent ---© IKS Consortium2010

78 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExtensions ---Includes ---Scope Linking rulesActor(s) ConsumerGoal Set the linking rule for automatic linkingTrigger The consumer wants to define the linking rule.Preconditions1. Linking rules have been defined by an advanced consumer.Minimal Postconditions1. The linking service provides a status response to the user.Success Postconditions1. The consumer selects the linking rules and set them for the automatic linkingprocessing.Main Flow1. Browse in the existing rules.2. Choose matching linking rules.3. Set linking rules for automatic linking.Exceptions1. Repository of linking rules can not be accessed.UC-230211: Define linking rulesUse Case ID UC-230211: Define linking rules [SC4]Description The linking rules are defined by an advanced consumer. The definition of rulescontains the creation and the editing of rules. In addition to these basicoperations, the linking rules can also be persisted in a rule repository.Parent ---Extensions Repository: UC-230207Includes ---Scope Linking rulesActor(s) Advanced consumer© IKS Consortium2010

79 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseGoal A set of linking rules for the automatic linking of content items can be definedby the advanced consumer.Trigger The advanced consumer triggers the definition of linking rules in order tocustomize the automatic linking creation.Preconditions1. The advanced consumer has the access rights to create linking rules.Minimal Postconditions1. A status response is provided to the user.Success Postconditions1. The advanced consumer successfully defined the linking rules he requires.Main Flow1. Selecting an existing linking rule for changing or choose “Create new linking rule”2. Define the type of the relation3. Specify the conditions which have to be matched for the relation4. Define constraints with respect to the content types (e.g. “appropriate only for textualcontent items”)5. Define a meaningful name for the linking rule.Exceptions1. The linking rule editor is not available.2. The access to the linking rule editor is permitted to the advanced user (missing accessrights)UC-230212: Create linking rulesUse Case ID UC-230212: Create linking rules [SC4]Description The advanced user creates a new linking rule. By this rule the automatic linkingof content items can be configured.Parent UC-230211Extensions ---Includes ---Scope Linking rulesActor(s) Advanced consumerGoal Creation of rules for automatic linking.© IKS Consortium2010

80 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseTrigger The advanced consumer created linking rules.UC-230213: Edit linking rulesUse Case ID UC-230213: Edit linking rules [SC4]Description The advanced user edits an existing linking rule. By this rule the automaticlinking of content items can be configured.Parent UC-230211Extensions ---Includes ---Scope Linking rulesActor(s) Advanced consumerGoal Editing of existing rules for automatic linking.Trigger The advanced consumer edits linking rules.Preconditions1. Linking rules have been created and can be edited.2. The user has access rights to the linking rules.Minimal Postconditions1. The service provides a status response to the user.Success Postconditions1. The consumer edits the linking successfully.Main Flow1. Browse existing linking rules.2. Choose linking rule.3. Edit linking rule.Exceptions1. No linking rules are available.2. The access to the linking rule is denied.a. Missing access rights of the user.b. The linking rule is blocked by another user.UC-230214: Provide results in a reusable format© IKS Consortium2010

81 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230214: Provide results in a reusable format [SC1, SC2]Description It should be possible to store the links locally in the CMS in a domain-specificdata structure or format for further processing. In order to achieve this kind ofinteroperability of the results (the links itself) of the automatic automaticcreation should be specified in a reusable format by the IKS. This should be anoptional extension of the “Perform automatic creation of links” use case.Parent ---Extensions ---Includes ---Scope Reuse of linksActor(s) IKSGoal The specified links can be reused for further processing the CMS.Trigger Performing of the automatic link creation.UC-230215: Interpret defined linking rulesUse Case ID UC-230215: Interpret defined linking rules [SC5]Description The automatic creation of links can be customized by linking rules. In order tobe able to consider the rules, they must be interpreted by IKS for the linkcreation.Parent ---Extensions ---Includes ---Scope Linking rulesActor(s) IKSGoal The defined linking rules are interpreted by the IKS.Trigger The creation of links is customized by a set of rules.Preconditions1. The linking rules have been defined by an advanced consumer.Minimal Postconditions1. The rule engine provides feedback about the rule interpretation.© IKS Consortium2010

82 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseSuccess PostconditionsMain FlowExceptions1. The rules have been successfully interpreted by the IKS rule engine.1. Check rules for syntactical correctness.2. Interpret linking rules and provide customization.1. Linking rule cannot be interpreted.a. Linking rule is syntactically invalid.b. Interpreter service / engine is not available.UC-230216: Identify type of linkUse Case ID UC-230216: Identify type of link [SC1, SC2]Description In order to be able to set links between content items, the type of the link of theidentified. Therefore the semantics of the content items are analyzed. Basedon the results of this analysis an appropriate link type is choosen describingthe relation between the items.Parent ---Extensions ---ActionIncludes ---Scope LinkingActor(s) IKS ServiceGoal The linking type for the relation between two content items is identified.Trigger A link should be set between two content items.© IKS Consortium2010

83 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 35: Activity diagram for use case UC-230216UC-230217: Perform automatic creation of linksUse Case ID UC-230217: Perform automatic creation of links [SC1, SC2, SC5]Description The automatic linking is performed by executing the IKS service.Parent ---Extensions Linking rules: UC-230225Results: UC-230214Includes UC-230220© IKS Consortium2010

84 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseScope Automatic linkingActor(s) IKS ServiceGoal The links between content items are created automatically.Trigger The consumer triggers the automatic linking.Action© IKS Consortium2010

85 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 36: Activity diagram for use case UC-230217UC-230218: Perform automatic creation of horizontal links© IKS Consortium2010

86 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230218: Perform automatic creation of horizontal links [SC1]Description The automatic creation of horizontal links is a specialization of UC-230217.Horizontal links connect content items on a common description level (e.g.requirement specifications).Parent UC-230217Extensions ---Includes ---Scope Automatic linkingActor(s) IKS ServiceGoal Automatic creation of horizontal links.Trigger The automatic link creation is requested by the consumer.UC-230219: Perform automatic creation of vertical linksUse Case ID UC-230219: Perform automatic creation of vertical links [SC2]Description The automatic creation of veritical links is a specialization of UC-230217.Vertical links connect content items on a different description level (e.g.requirement specifications and architectural diagrams).Parent UC-230217Extensions ---Includes ---Scope Automatic linkingActor(s) IKS ServiceGoal The IKS automatically creates links between content items on differentdescription levels.Trigger The automatic link creation is requested by the consumer.UC-230220: Set links between content itemsUse Case ID UC-230220: Set links between content items [SC1, SC2]Description The links between content items are set reflecting the relations anddependencies among them.© IKS Consortium2010

87 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---Includes UC-230216Scope Automatic linkingActor(s) IKS ServiceGoal The IKS sets links between content items.Trigger The automatic link creation is requested by the consumer.UC-230221: Analyze relations between content itemsUse Case ID UC-230221: Analyze relations between content items [SC1, SC2]Description Setting links between content items requires an analysis of relations anddependencies among the items to be linked.Parent ---Extensions Textual analysis: UC-230222Non-textual analysis: UC-230223ActionIncludes ---Scope Automatic linkingActor(s) IKS ServiceGoal The content items are analyzed and thereby the kind of relations among themcan be derived.Trigger The automatic linking service of the IKS triggers the identification of linkingtypes.© IKS Consortium2010

88 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 37: Activity diagram for use case UC-230221UC-230222: Analyze textual content itemsUse Case ID UC-230222: Analyze textual content items [SC1, SC2]Description The analysis of content items is a prerequisite for identifying relations among© IKS Consortium2010

89 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---Includes ---them. As an extension for handling textual content items, the semantics of textualcontent items could be analyzed.Scope Automatic linkingActor(s) IKS ServiceGoal The IKS analyses the textual content items to provide information aboutrelations to other content items.Trigger The IKS service tries to identify relations and dependencies among the contentitems.Preconditions1. The corresponding content item has been checked and identified as a textual typeMinimal Postconditions1. The analysis service provides a status response to the user.Success Postconditions1. The textual content items have been analyzed successfully and the results can beused to identify relations to other content items.Main Flow1. Load content item to the analysis engine.2. Handle content and perform analysis algorithm.3. Provide results to linking service.Exceptions1. The content item cannot be analyzeda. The content has been corrupted.b. The format of the content item cannot be processed by the analysis service2. No semantics have been identified to derive relationsUC-230223: Analyze non-textual content itemsUse Case ID UC-230223: Analyze non-textual content items [SC2]Description The analysis of content items is a prerequisite for identifying relations amongthem. As an extension for handling of non-textual content items, the semantics© IKS Consortium2010

90 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---Includes ---of non-textual content items (e.g. images) could be analyzed.Scope Automatic linkingActor(s) IKS ServiceGoal The IKS analyses the non-textual content items to provide information aboutrelations to other content items.Trigger The IKS service tries to identify relations and dependencies among the contentitems.Preconditions1. The corresponding content item has been checked and identified as a non-textualtypeMinimal Postconditions2. The analysis service provides a status response to the user.Success Postconditions2. The non-textual content items have been analyzed successfully and the resultscan be used to identify relations to other content items.Main Flow4. Load content item to the analysis engine.5. Handle content and perform analysis algorithm.6. Provide results to linking service.Exceptions3. The content item cannot be analyzeda. The content has been corrupted.b. The format of the content item cannot be processed by the analysis service4. No semantics have been identified to derive relationsUC-230224: Suggest links to existing content itemsUse Case ID UC-230224: Suggest links to existing content items [SC3]Description After creating new content or editing existing content, the consumer can selectthe auto-auggestion service of the IKS. This service provides a list ofsuggested links to existing content items. The corresponding IKS service© IKS Consortium2010

91 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---Includes ---calculates suggestions for these links and provide them as a ranked list to theconsumer.Scope Auto-suggestionActor(s) IKS ServiceGoal According the content item edited by the consumer and the content in theCMS, suggestion for links are calculated.Trigger The consumer triggers the auto-suggestion service of the IKS.UC-230225: Customize creation of links by linking rulesUse Case ID UC-230225: Customize creation of links by linking rules [SC5]Description In order to customize the way links are created among content items, theadvanced consumer is able to define a set of linking rules. Using these rules,the IKS Service can customize the creation of links among content items.Parent ---Extensions ---ActionIncludes UC-230215Scope Linking rulesActor(s) IKS ServiceGoal The IKS service customizes the link creation by the defines rules sets.Trigger The consumer requested the automatic linking service of the IKS.© IKS Consortium2010

92 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 38: Activity diagram for use case UC-2302253.2.3 Resulting Requirements DescriptionFunctional RequirementsID Requirement UC-RefFR-230201 The IKS shall be able to interpret defined linking rules.FR-230202 The IKS shall be able to recognize the type of relation between contentitems.FR-230203 The IKS shall be able to automatically create links between content items.UC-230215UC-230216UC-230217© IKS Consortium2010

93 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement UC-RefFR-230204 The IKS shall be able to automatical create links between cross-type content UC-230219items.FR-230205 The IKS shall be able to analyze the relation between content items. UC-230221FR-230206 The IKS shall be able to set links between content items.FR-230207 The IKS shall be able to analyze textual content items.FR-230208 The IKS shall be able to analyze non-textual content items.FR-230209 The IKS shall provide a link-suggestion to existing content items.FR-230210 The IKS shall provide the creation of linking rules.FR-230211 The creation of links shall be configurable by linking rules.Data requirementsUC-230220UC-230222UC-230223UC-230223UC-230211UC-230225ID Requirement UC-RefDR-230201 The IKS shall provide the results of the automatic linking in a reusableformat.UC-230214Interface requirementsID Requirement UC-RefIR-230201 The IKS shall be able to process defined linking rules.IR-230202 The IKS shall be able to process linking rules load from the repository.IR-230203 The links calculated in the IKS shall storable in the CMS repository.UC-230211UC-230203UC-230203Non functional requirementsID Requirement UC-RefNFR-230201 The IKS automatic linking shall be semantic service.NFR-220202 The IKS auto-suggestion shall be semantic service.UC-230206UC-2302093.3 HLR-2303: Calculation of correlation among contentHLR IDNameDescriptionHLR-2303Calculation of correlation among contentThe IKS should be able to calculate the correlation among differentcontent items. The calculated similarity between content items can beused to identify duplicates even in complex project scopes. Furthermorethis functionality can be used to reorganize content, e.g. by aggregatingsimilar content items.© IKS Consortium2010

94 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseClassificationDomainsVerticalSoftware engineering (Validation)Relatedrequirements3.3.1 ScenariosScenario 1 (Semi-automatic deletion of duplicates):In a software project the software requirements have been elicited and documented. The requirementsspecification is described in textual format. In order to consolidate the requirements,the specification shall be checked for redundancy. Therefore IKS should provide aservice for a (semi-) automatic deletion of duplicates. The service calculates the correlationamong two requirements in percentage and the user is able to decide if the requirements areduplicates and can be consolidated.© IKS Consortium2010

95 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 39: Use case diagram for HLR-2303 scenario 1Scenario 2 (Ranked listing of similar content):After processing the deletion of duplicates as described in scenario 1 the project managerwants to aggregate the requirements of the specification. Therefore he requested a rankedlist of similar content items to identify the potential of content aggregation. The list containsrelated content items and the degree of similarity in percentage.© IKS Consortium2010

96 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 40: Use case diagram for HLR-2303 scenario 23.3.2 Use Case DescriptionsUC-230301: Define threshold of similarity for duplicate identification [SC1]UC-230302: Duplicate check [SC1]UC-230303: Submit deletion of duplicates [SC1]UC-230304: Perform content duplicate check [SC1]UC-230305: Calculate similarity among content items [SC1, SC2]UC-230306: Check similarity rating against defined threshold [SC1]UC-230307: Present suggested duplicates [SC1]UC-230308: Similarity check [SC2]UC-230309: Aggregate content based on similarity ranking [SC2]UC-230310: Perform similarity check [SC2]UC-230311: Present results in ranked list [SC2]© IKS Consortium2010

97 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse cases from other HLRs UC-230101: Send IKS service request [SC1, SC2] UC-230111: Execute [SC1, SC2, SC3]UC-230301: Define threshold of similarity for duplicate identificationUse Case ID UC-230301: Define threshold of similarity for duplicate identification [SC1]Description In order to customize the duplicate identification, the consumer is able to set athreshold of similarity (e.g.: 95 %) which is used for the finding of duplicates.Parent ---Extensions ---Includes ---Scope Duplicate identificationActor(s) ConsumerGoal The consumer defined the threshold according to his “understanding” of aduplicate.Trigger The consumer wants to customize the identification of duplicates.UC-230302: Duplicate checkUse Case ID UC-230302: Duplicate check [SC1]Description The consumer starts the duplicate check and the content duplicate checkservice is performed.Parent UC-230101Extensions ---ActionIncludes ---Scope Duplicate identificationActor(s) ConsumerGoal The duplicate check service is performed.Trigger The consumer triggers the duplicate check.© IKS Consortium2010

98 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 41: Activity diagram for use case UC-230302UC-230303: Submit deletion of duplicatesUse Case ID UC-230303: Submit deletion of duplicates [SC1]Description After identifying possible duplicates, the consumer is able to browse and semiautomaticallydelete the proposed duplicates.Parent ---Extensions ---Includes ---Scope Handling of duplicatesActor(s) ConsumerGoal The consumer deletes a suggestes duplicate.© IKS Consortium2010

99 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseTrigger The consumer triggers the duplicate check andUC-230304: Perform content duplicate check [SC1]Use Case ID UC-230304: Perform content duplicate check [SC1]Description The duplicate check itself is performed by executing the corresponding IKSservice.Parent UC-230111Extensions Presentation: UC-230307ActionIncludes UC-230305UC-230306Scope Duplicate checkActor(s) IKS ServiceGoal The content duplicate check is performed successfully and the results arecalculatedTrigger The consumer triggers the duplicate check and the IKS service is called.© IKS Consortium2010

100 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 42: Activity diagram for use case UC-230304© IKS Consortium2010

101 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230305: Calculate similarity among content itemsUse Case ID UC-230305: Calculate similarity among content items [SC1, SC2]Description To identify duplicates, the similarity between content items is calculated.According to this, textual content items are analyzed and compared to each toidentify similarities.Parent ---Extensions ---Includes ---Scope Identification of duplicatesActor(s) IKS ServiceGoal The similarity between textual content items is calculated.Trigger The content duplicate check service performs the similarity calculation.UC-230306: Check similarity rating against defined thresholdUse Case ID UC-230306: Check similarity rating against defined threshold [SC1]Description The IKS Service checks the calculated similarity against the threshold definedby the consumer. This indicated whether content items are marked asduplicatesParent ---Extensions ---Includes ---Scope Identification of duplicatesActor(s) IKS ServiceGoal The calculated similarity is checked against the defined threshold.Trigger The duplicate or similarity checking service is performed.UC-230307: Present suggested duplicates© IKS Consortium2010

102 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230307: Present suggested duplicates [SC1]Description As an optional extension of the duplicate check, the IKS provides apresentation service for presenting the suggested duplicates. Using thispresentation, the consumer is supported by the browsing through the results.Parent ---Extensions ---Includes ---Scope PresentationActor(s) IKSGoal The results are presented to the consumer in an feasible format.Trigger The consumer customizes the presentation of the results by the correspondingIKS service.UC-230308: Similarity checkUse Case ID Similarity check [SC2]Description The consumer starts the similarity check and the corresponding IKS service isperformed.Parent UC-230101Extensions ---ActionIncludes ---Scope Content aggregationActor(s) ConsumerGoal The similarity check service is performed.Trigger The consumer triggers the similarity check.© IKS Consortium2010

103 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 43: Activity diagram for use case UC-230308UC-230309: Aggregate content based on similarity rankingUse Case ID UC-230309: Aggregate content based on similarity ranking [SC2]Description Using the results of the similarity the consumer aggregates similar contentitems. Providing a ranked list of similar content the decisions of the consumerare supported by the similarity check.Parent ---Extensions ---Includes ---Scope Content aggregationActor(s) Consumer© IKS Consortium2010

104 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseGoal Similar content items are aggregated by the consumer, supported by thesimilarity check.Trigger The consumer starts the similarity service and continues working on theprovided results.Preconditions1. The similarity check has been performed successfully.Minimal Postconditions1. No content items are lost accidentally and the user can still work on the content.Success Postconditions1. Using the results of the similarity analysis, the consumer can efficiently aggregatethe content.UC-230310: Perform similarity checkUse Case ID UC-230310: Perform similarity check [SC2]Description The similarity check itself is performed by executing the corresponding IKSservice.Parent UC-230111Extensions Presentation: UC-230311ActionIncludes UC-230305Scope Similarity checkActor(s) IKS ServiceGoal The similarity check is performed successfully and the results are calculatedTrigger The consumer triggers the similarity check and the IKS service is called.© IKS Consortium2010

105 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 44: Activity diagram for use case UC-230310© IKS Consortium2010

106 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230311: Present results in ranked listUse Case ID UC-230311: Present results in ranked list [SC2]Description As an optional extension of the similarity check, the IKS provides apresentation service for presenting the calculation results in a ranked list ofrelated content items. Using this presentation, the consumer is supported bythe browsing through the results.Parent ---Extensions ---Includes ---Scope PresentationActor(s) IKSGoal The results are presented to the consumer in an feasible format.Trigger The consumer customizes the presentation of the results by the correspondingIKS service.3.3.3 Resulting Requirements DescriptionFunctional RequirementsID Requirement UC-RefFR-230301 The IKS shall be able to calculate the similarity between content itemsFR-230302 The IKS shall be able to check the similarity rating against a predefinedthreshold.FR-230303 The IKS shall be able to present a list of suggested duplicates.FR-230304 The IKS shall support the duplicate checking for content items.FR-230305 The IKS shall support the similarity check.FR-230306 The IKS shall be able to present the results in a ranked list.FR-230307 The IKS shall be able to calculate the degree of similarity between contentitems.UC-230305UC-230306UC-230507UC-230504UC-230501UC-230311UC-230305Integration requirementsID Requirement UC-Ref© IKS Consortium2010

107 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement UC-RefINR-230301 The duplicates calculated by the IKS service shall be presentable in theCMS.INR-230302 The similarity calculated by the IKS service shall be presentable in a CMS.UC-230307UC-230311Interface requirementsID Requirement UC-RefIR-230301 The IKS shall be able to process defined similarity thresholds.UC-230301Non functional requirementsID Requirement UC-RefNFR-230301 The IKS content duplicate check shall be a semantic service.NFR-230302 The IKS content similarity check shall be a semantic service.UC-230302UC-2303083.4 HLR-2304: Information ExtractionHLR IDNameDescriptionClassificationDomainsRelatedrequirementsHLR-2304Information ExtractionThe IKS should provide a functionality to analyze and “understand” thesemantics associated with content items. Therefore the IKS should beable to extract specific entities (e.g. names of persons, names ofplaces, activities, actors and so on) from texts and multimedia content.VerticalNews market for journalists’ teamsHLR-23053.4.1 ScenariosScenario 1 (Extraction of persons from photos/images):A sports journalist who writes an article about a football game needs to add informationabout the match that he/she followed. The journalist has photographs of a football match.The CMS should provide recognition algorithms to recognize the people in the photographsfrom their faces.© IKS Consortium2010

108 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 45: Use case diagram for HLR-2304 scenario 1Scenario 2 (Extract persons from video files):© IKS Consortium2010

109 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseAccording to the photographs in scenario 1, the CMS should also provide a service, usingappropriate algorithms, which can extract information about people and location from videos.Therefore persons shown in the video stream can be identified.Figure 46: Use case diagram for HLR-2304 scenario 2© IKS Consortium2010

110 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseScenario 3 (Extract locations from video files):In addition to scenario 2, the CMS should also provide a service, using appropriate algorithms,which can extract information about locations from videos. Therefore locations shownin the video stream can be identified.Figure 47: Use case diagram for HLR-2304 scenario 3© IKS Consortium2010

111 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseScenario 4 (Extract specific events from video files):With respect to scenario 2 and 3 a further improvement is expected: the IKS should be ableto identify specific events and mark them with tag timestamp (e.g. at time 2:10 there is a goalby the striker, at time 15:34 a red card, etc.). This information allows browsing automaticallygenerated highlights.© IKS Consortium2010

112 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 48: Use case diagram for HLR-2304 scenario 4Scenario 5 (Extraction of information from texts):In addition to scenarios 1 and 2, the CMS should provide services to collect information relatingto the examined text. The IKS should be able to extract specific entities (e.g. names ofpersons, companies, location ,…) from texts.© IKS Consortium2010

113 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 49: Use case diagram for HLR-2304 scenario 5© IKS Consortium2010

114 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case3.4.2 Use Case DescriptionsCMSUC-230401: Store recognized information [SC1, SC2,SC3,SC4,SC5]Consumer UC-230402: Face recognition [SC1,SC2] UC-230403: Location recognition [SC3] UC-230404: Event recognition [SC4] UC-230405: Entity recognition [SC5] UC-230406: Browse automatically generated highlights [SC4]Advanced consumer: UC-230407: Specify types of locations to be recognized [SC3] UC-230408: Specify types of events to be recognized [SC4] UC-230409: Specify entities to be recognized [SC5]IKS: UC-230410: Provide reusable presentation of biometrical data [SC1,SC2] UC-230411: Provide reusable presentation of extracted data[SC1,SC2,SC3,SC4,SC5] UC-230412: Automatically generate highlight selection [SC4]IKS Customizer: UC-230413: Define biometrical algorithms for face recognition [SC1,SC2] UC-230414: Define recognition algorithms for different location types [SC3] UC-230415: Define recognition algorithms for different types of events [SC4] UC-230416: Define recognition algorithms for different types of entities [SC5]IKS Service: UC-230417: Perform face recognition [SC1,SC2] UC-230418: Perform location recognition [SC3] UC-230419: Perform event recognition [SC4] UC-230420: Perform entity recognition [SC5] UC-230421: Analyse photo [SC1] UC-230422: Analyze video stream [SC2, SC3, SC4] UC-230423: Analyze textual content [SC5] UC-230424: Identify faces in photo [SC1] UC-230425: Identify faces in video stream [SC2] UC-230426: Extract biometrical data [SC1, SC2] UC-230427: Extract location data [SC3] UC-230428: Extract entities and corresponding information [SC5] UC-230429: Extract event data [SC4] UC-230430: Mark timestamp of event [SC4]Use cases from other HLRs UC-230101: Send IKS service request [SC1, SC2,SC3,SC4,SC5] UC-230111: Execute [SC1,SC2,SC3,SC4,SC5]© IKS Consortium2010

115 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230401: Store recognized informationUse Case ID UC-230401: Store recognized information [SC1, SC2,SC3,SC4,SC5]Description The information extracted from the content by the recognition algorithmsshould be stored in the CMS. Thereby the extracted information can be reusedby the consumer to enrich existing content items.Parent ---Extensions ---Includes ---Scope PersistenceActor(s) CMSGoal The extracted information can be stored locally in the CMS.Trigger The rocognition service is performed and the results are sent back to the CMS.UC-230402: Face recognitionUse Case ID UC-230402: Face recognition [SC1,SC2]Description In order to identify persons on photos or video streams, the consumer startsthe face recognition. A service request is sent to the IKS and handled by therecognition engine.Parent UC-230101Extensions ---ActionIncludes UC-230417Scope Face recognitionActor(s) ConsumerGoal The face recognition is performed using the defined biometrical recognitionalgorithms.Trigger The consumer starts the face recognition© IKS Consortium2010

116 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 50: Activity diagram for use case UC-230402UC-230403: Location recognitionUse Case ID UC-230403: Location recognition [SC3]Description In order to identify locations in video streams, the consumer starts the locationrecognition. An advanced consumer predefines which kinds of locations shouldbe recognized. A service request is sent to the IKS and handled by therecognition engine.Parent UC-230101Extensions ---Includes UC-230418Scope Location recognitionActor(s) Consumer© IKS Consortium2010

117 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionGoal The location recognition is performed using the defined recognition algorithmsfor different kinds of locations.Trigger The consumer starts the location recognitionFigure 51: Activity diagram for use case UC-230403UC-230404: Event recognitionUse Case ID UC-230404: Event recognition [SC4]Description In order to identify events in video streams, the consumer starts the eventrecognition. An advanced consumer predefines which kinds of events shouldbe recognized. A service request is sent to the IKS and handled by therecognition engine.Parent UC-230101Extensions ---© IKS Consortium2010

118 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionIncludes UC-230419Scope Event recognitionActor(s) ConsumerGoal The event recognition is performed using the defined recognition algorithms fordifferent kinds of events.Trigger The consumer starts the event recognitionFigure 52: Activity diagram for use case UC-230404UC-230405: Entity recognitionUse Case ID UC-230405: Entity recognition [SC5]Description In order to identify entities in video streams, the consumer starts the entityrecognition. An advanced consumer predefines which kinds of entities shouldbe recognized. A service request is sent to the IKS and handled by the© IKS Consortium2010

119 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Caserecognition engine.Parent UC-230101Extensions ---ActionIncludes UC-230419Scope Entitiy recognitionActor(s) ConsumerGoal The entitiy recognition is performed using the defined recognition algorithms fordifferent kinds of entities.Trigger The consumer starts the entitiy recognitionFigure 53: Activity diagram for use case UC-230405UC-230406: Browse automatically generated highlights© IKS Consortium2010

120 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230406: Browse automatically generated highlights [SC4]Description After performing the event recognition, the results are stored in the CMS.Furthermore a collection of highlights (identified events in combination withmarked timestamp of event) should be available with is browsable by theconsumer.Parent ---Extensions ---Includes ---Scope Event recognitionActor(s) ConsumerGoal The consumer is able to browse in a collection of recognized highlights.Trigger The consumer starts the content browser.Preconditions1. The event recognition has been processed successfully and extracted events andtimestamps have been stored in the CMS.Minimal Postconditions1. The consumer gets a status response.Success PostconditionsMain Flow1. The consumer can successfully browse the recognized highlights.1. ---Exceptions1. No highlights have been identified by the event recognition.UC-230407: Specify types of locations to be recognizedUse Case ID UC-230407: Specify types of locations to be recognized [SC3]Description The advanced consumer can customize the kinds of locations which should berecognized by the algorithm (e.g. buildings, streets, landscape, …).Parent ---© IKS Consortium2010

121 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExtensions ---Includes ---Scope Location recognitionActor(s) Advanced consumerGoal The advanced consumer specified the type of locations.Trigger In order to customize the location recognition, the advanced consumer startsthe specification editor.UC-230408: Specify types of events to be recognizedUse Case ID UC-230408: Specify types of events to be recognized [SC4]Description The advanced consumer can customize the kinds of events which should berecognized by the algorithm (e.g. a goal in a football match, …).Parent ---Extensions ---Includes ---Scope Event recognitionActor(s) Advanced consumerGoal The advanced consumer specified the type of events.Trigger In order to customize the event recognition, the advanced consumer starts thespecification editor.UC-230409: Specify entities to be recognizedUse Case ID UC-230409: Specify entities to be recognized [SC5]Description The advanced consumer can customize the kinds of entities which should berecognized by the algorithm (e.g. names of persons, companies, trademarketc.).Parent ---Extensions ---Includes ---© IKS Consortium2010

122 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseScope Entity recognitionActor(s) Advanced consumerGoal The advanced consumer specified the type of entities.Trigger In order to customize the entity recognition, the advanced consumer starts thespecification editor.UC-230411: Provide reusable presentation of extracted dataUse Case ID UC-230411: Provide reusable presentation of extracted data[SC1,SC2,SC3,SC4,SC5]Description The data extracted by a recognition service should be stored in the CMS forfurther reuse. Therefore the IKS should be able to provide these results in areusable format to the CMS.Parent ---Extensions ---Includes ---Scope Data presentationActor(s) IKSGoal The results of the recognition can be reused in the CMS.Trigger A recognition service is performed.UC-230412: Automatically generate highlight selectionUse Case ID UC-230412: Automatically generate highlight selection [SC4]Description After performing the event recognition a collection of “highlights” should beprovided to the consumer. Using the extracted event data and timestamp thecollection is automatically generated by the IKS.Parent ---Extensions ---Includes ---Scope Event recognitionActor(s) IKS© IKS Consortium2010

123 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseGoal The automatic creation of a “highlight” collection that is provided to theconsumer.Trigger The event recognition service is performed.UC-230413: Define biometrical algorithms for face recognitionUse Case ID UC-230413: Define biometrical algorithms for face recognition [SC1,SC2]Description The face recognition service is able to identify persons on photos or in videostreams. This functionality is implemented by corresponding biometricalrecognition algorithms. In order to be able to customize these algorithms, theIKS customizer can configure the algorithms itself.Parent ---Extensions ---Includes ---Scope Face recognitionActor(s) IKS customizerGoal The IKS customizer defines or edits an existing biometrical algorithm for theface recognition service.Trigger The need for an adaption of the calculation triggers the definiton of thealgorithms.UC-230414: Define recognition algorithms for different location typesUse Case ID UC-230414: Define recognition algorithms for different location types [SC3]Description The location recognition service is able to identify different kinds of locations invideo streams. This functionality is implemented by corresponding recognitionalgorithms. In order to be able to customize these algorithms, the IKScustomizer can configure the algorithms itself.Parent ---Extensions ---Includes ---Scope Location recognitionActor(s) IKS customizer© IKS Consortium2010

124 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseGoal The IKS customizer defines or edits an existing algorithm for the locationrecognition service.Trigger The need for an adaption of the calculation triggers the definiton of thealgorithms.UC-230415: Define recognition algorithms for different types of eventsUse Case ID UC-230415: Define recognition algorithms for different types of events [SC4]Description The event recognition service is able to identify events in video streams. Thisfunctionality is implemented by corresponding recognition algorithms. In orderto be able to customize these algorithms, the IKS customizer can configure thealgorithms itself.Parent ---Extensions ---Includes ---Scope Event recognitionActor(s) IKS customizerGoal The IKS customizer defines or edits an existing algorithm for the eventrecognition service.Trigger The need for an adaption of the calculation triggers the definiton of thealgorithms.UC-230416: Define recognition algorithms for different types of entitiesUse Case ID UC-230416: Define recognition algorithms for different types of entities [SC5]Description The entity recognition service is able to identify different kinds of entities intexts. This functionality is implemented by corresponding recognitionalgorithms. In order to be able to customize these algorithms, the IKScustomizer can configure the algorithms itself.Parent ---Extensions ---Includes ---Scope Location recognitionActor(s) IKS customizer© IKS Consortium2010

125 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseGoal The IKS customizer defines or edits an existing algorithm for the entityrecognition service.Trigger The need for an adaption of the calculation triggers the definiton of thealgorithms.UC-230417: Perform face recognitionUse Case ID UC-230417: Perform face recognition [SC1,SC2]Description The face recognition itself is performed by executing the IKS service.Parent ---Extensions Video analysis: UC-230421Photo analysis: UC-230422ActionIncludes ---Scope Face recognitionActor(s) IKS ServiceGoal The face recognition is performed and the biometrical data are extracted.Trigger The consumer starts the face recognition.© IKS Consortium2010

126 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 54: Activity diagram for use case UC-230417UC-230418: Perform location recognitionUse Case ID UC-230418: Perform location recognition [SC3]Description The location recognition itself is performed by executing the IKS service.Parent ---© IKS Consortium2010

127 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExtensions Video analysis: UC-230421Includes ---Scope Location recognitionActor(s) IKS ServiceGoal The location recognition is performed and the data extracted.Trigger The consumer starts the location recognition.Action© IKS Consortium2010

128 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 55: Activity diagram for use case UC-230418UC-230419: Perform event recognition© IKS Consortium2010

129 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230419: Perform event recognition [SC4]Description The event recognition itself is performed by executing the IKS service.Parent ---Extensions Video analysis: UC-230421Includes ---Scope Event recognitionActor(s) IKS ServiceGoal The event recognition is performed and the data extracted.Trigger The consumer starts the event recognition.Action© IKS Consortium2010

130 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 56: Activity diagram for use case UC-230419© IKS Consortium2010

131 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230420: Perform entity recognitionUse Case ID UC-230420: Perform entity recognition [SC5]Description The entity recognition itself is performed by executing the IKS service.Parent ---Extensions Text analysis: UC-230423Includes ---Scope Entity recognitionActor(s) IKS ServiceGoal The entity recognition is performed and the data extracted.Trigger The consumer starts the entity recognition.Action© IKS Consortium2010

132 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 57: Activity diagram for use case UC-230420UC-230421: Analyse photo© IKS Consortium2010

133 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230421: Analyse photo [SC1]Description The analysis is an optional extension of the face recognition addressing theprocessing of photographs. The photo analysis itself is extended by a servicefor the identification of faces providing the main functionality for the facerecognition service.Parent ---Extensions Face recognition: UC-230424Includes ---Scope Content analysisActor(s) IKS ServiceGoal The photo is analyzed and optionally faces are identified in the photo.Trigger The face recognition is performed for photograph.UC-230422: Analyze video streamUse Case ID UC-230422: Analyze video stream [SC2, SC3, SC4]Description The analysis is an optional extension of the face, location and eventrecognition addressing the processing of video streams. The video analysisitself is extended by services for the identification of faces, locations andevents providing the main functionality for these services.Parent ---Extensions Face recognition: UC-230425Location recognition: UC-230427Event recognition: UC-230429Includes ---Scope Content analysisActor(s) IKS ServiceGoal The video stream is analyzed and faces, locations or events are identified inthe photo.Trigger The face, location or event recognition service is performed for a video stream.UC-230423: Analyze textual content© IKS Consortium2010

134 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUse Case ID UC-230423: Analyze textual content [SC5]Description The analysis is an optional extension of the entity recognition addressing theprocessing of textual content. The text analysis itself is extended by a servicefor the extraction of entities providing the main functionality for the entityrecognition service.Parent ---Extensions Entities recognition: UC-230428Includes ---Scope Content analysisActor(s) IKS ServiceGoal The text is analyzed and optionally entities are identified.Trigger The entity recognition is performed for a textual content item.UC-230424: Identify faces in photoUse Case ID UC-230424: Identify faces in photo [SC1]Description The analysis of photos can be extended by the identification of faces in thephotos. This face recognition is performed by the extraction of biometrical datawhich is analysed to identify faces and the corresponding persons.Parent ---Extensions ---Includes UC-230426Scope Face recognitionActor(s) IKS ServiceGoal The faces in photos are recognized and the persons can be identified.Trigger The photo of photos is performed to recognize faces.UC-230425: Identify faces in video streamUse Case ID UC-230425: Identify faces in video stream [SC2]Description The analysis of video streams can be extended by the identification of faces inthe video streams. This face recognition is performed by the extraction of© IKS Consortium2010

135 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---biometrical data which is analysed to identify faces and the correspondingpersons.Includes UC-230426Scope Face recognitionActor(s) IKS ServiceGoal The faces in video streams are recognized and the persons can be identified.Trigger The photo of photos is performed to recognize faces.UC-230426: Extract biometrical dataUse Case ID UC-230426: Extract biometrical data [SC1, SC2]Description Using defined algorithms, biometrical data can extracted from content items.Biometrics can be used to identify humans in visual content (e.g. photos orvideos, …). By analyzing this data not only a human in general but also thespecific person can be identified.Parent ---Extensions ---Includes ---Scope Face recognitionActor(s) IKS ServiceGoal The biometrical data contained in a visual content item is successfullyextracted.Trigger The face recognition service is performed and a photo or video stream isanalyzed.Preconditions1. The photo or video stream is available in an appropriate format.Minimal Postconditions1. The service provides a status response to the user.© IKS Consortium2010

136 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseSuccess Postconditions1. The biometrics have successfully been extracted and can be processed by therecognition engine.Main Flow1. Open content item2. Pre-analysis: Check resolution and format of content item3. Process biometrical algorithms to extract biometrical data4. Provide the results to the face recognition serviceExceptions1. The content item can not be used for the analysisa. The content items is an unsupported formatb. The resolution of the content item is not sufficiently for the biometrical algorithmsUC-230427: Extract location data [SC3]Use Case ID UC-230427: Extract location data [SC3]Description Using defined algorithms, different kinds of locations can be extracted fromcontent items. The algorithms are able to extract characteristics of specificlocation types (e.g. building, landscape, etc.) from video streams and thereforeprovide a list of locations which are shown in a video.Parent ---Extensions ---Includes ---Scope Location recognitionActor(s) IKS ServiceGoal The location data contained in the video stream is successfully extracted.Trigger The location recognition service is performed and the video stream is analyzed.Preconditions1. The video stream is available in an appropriate format.Minimal Postconditions1. The service provides a status response to the user.© IKS Consortium2010

137 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseSuccess Postconditions1. The location data has successfully been extracted and can be processed by therecognition engine.Main Flow1. Load video stream to analysis engine2. Pre-analysis: Check resolution and format of video stream3. Process algorithms to extract location data4. Provide the results to the location recognition serviceExceptions1. The content item can not be used for the analysisa. The content items is an unsupported formatb. The resolution of the content item is not sufficiently for the algorithmsUC-230428: Extract entities and corresponding informationUse Case ID UC-230428: Extract entities and corresponding information [SC5]Description Using defined algorithms, entites (e.g. names of persons, places, businessstatements, etc…) can be extracted from texts. The algorithms are able toextract entities with the corresponding informations from text files.Parent ---Extensions ---Includes ---Scope Entity recognitionActor(s) IKS ServiceGoal The entity data contained in a textual content item is successfully extracted.Trigger The entity recognition service is performed and a textual item is analyzed.Preconditions1. The text is available in an appropriate format.Minimal Postconditions1. The service provides a status response to the user.Success Postconditions1. The entities have successfully been extracted and can be processed by the recognitionengine.© IKS Consortium2010

138 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseMain Flow1. Load text to analysis engine2. Pre-analysis: Check language of the text against language support of analysisengine3. Process algorithms to extract entities mentioned in the text4. Provide the results to the entity recognition serviceExceptions1. The content item can not be used for the analysisa. The content items is an unsupported formatb. The text is in an unsupported languageUC-230429: Extract event dataUse Case ID UC-230429: Extract event data [SC4]Description Using defined algorithms, different kinds of events can be extracted from videofiles. The algorithms are able to extract characteristics of specific event types(e.g. a goal in a football match) from video streams. The timestamp of an eventcan also be identified to provide a chronological list of events occuring in avideoParent ---Extensions ---Includes UC-230430Scope Event recognitionActor(s) IKS ServiceGoal The event data contained in the video stream is successfully extracted.Trigger The event recognition service is performed and the video stream is analyzed.Preconditions1. The video stream is available in an appropriate format.Minimal Postconditions1. The service provides a status response to the user.Success Postconditions1. The event data has successfully been extracted and can be processed by therecognition engine.Main Flow1. Load video stream to analysis engine© IKS Consortium2010

139 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case2. Pre-analysis: Check resolution and format of video stream3. Process algorithms to extract event data4. Provide the results to the event recognition serviceExceptions1. The content item can not be used for the analysisa. The content items is an unsupported formatb. The resolution of the content item is not sufficiently for the algorithmsUC-230430: Mark timestamp of eventUse Case ID UC-230430: Mark timestamp of event [SC4]Description The extraction of data from video streams also includes the marking of thetimestamp at which the event takes place.Parent ---Extensions ---Includes ---Scope Event recognitionActor(s) IKS ServiceGoal The timestamp of an event is set.Trigger The event data is extracted from a video stream.3.4.3 Resulting Requirements DescriptionFunctional RequirementsID Requirement UC-RefFR-230401 The IKS shall support face recognition.FR-230402 The IKS shall support location recognition.FR-230403 The IKS shall support event recognition.FR-230404 The IKS shall support entity recognition.FR-230405 The IKS shall provide a reusable presentation of extracted data.FR-230406 The IKS shall be able to automatically generate a highlight selection by theevent recognition.FR-230407 The IKS shall provide the capability to define biometrical algorithms for facerecognition.UC-230402UC-230403UC-230404UC-230405UC-230411UC-230412UC-230413© IKS Consortium2010

140 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement UC-RefFR-230408 The IKS shall provide the capability to define recognition algorithms fordifferent types of locations.FR-230409 The IKS shall provide the capability to define recognition algorithms fordifferent types of events.FR-230410 The IKS shall provide the capability to define recognition algorithms fordifferent entities.FR-230411 The IKS shall be able to load content items from a CMS to the analysisengine.FR-230412 The IKS shall be identify the type of a content item.FR-230413 The IKS shall support the analysis of photos for the face recognition.UC-230414UC-230415UC-230416UC-230417UC-230418UC-230419UC-230420UC-230417UC-230421FR-230414 The IKS shall support the analysis of video streams for the face, location and UC-230422event recognition.FR-230415 The IKS shall support the analysis of textual content items for the recognition UC-230423of entities.FR-230416 The IKS shall be able to identify faces in photographs.UC-230424FR-230417 The IKS shall be able to identify faces in video streams.FR-230418 The IKS shall be able to extract biometrical data from visual content items.FR-230419 The IKS shall be able to extract location data from video streams.UC-230425UC-230426UC-230427FR-230420 The IKS shall be able to extract defined entities and information from texts. UC-230428FR-230421 The IKS shall be able to extract event data from video streams.FR-230422 The IKS shall be able to mark timestamps of events in video streams.Data requirementsUC-230429UC-230430ID Requirement UC-RefDR-230401 The IKS shall be able to process texts in common standard formats.DR-230402 The IKS shall be able to process video streams in common multimediastandard formats.DR-230403 The IKS shall be able to process photographs in common grahical standardformats.UC-230423UC-230422UC-230421Integration requirementsID Requirement UC-RefINR-230401 The information recognized by the IKS services shall be storeable in theCMSINR-230402 The content store in the CMS which should be recognized shall byaccessable for the IKS.UC-230401UC-230402© IKS Consortium2010

141 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseInterface requirementsID Requirement UC-RefIR-230401 The IKS shall be able to process specifications of location types to be UC-230407recognized.IR-230402 The IKS shall be able to process specifications of event types to be UC-230408recognized.IR-230403 The IKS shall be able to process specifications of entities to be recognized. UC-230409Non functional requirementsID Requirement UC-RefNFR-230401 The IKS face recognition functionality shall be a semantic service.NFR-220402 The IKS location recognition functionality shall be a semantic service.NFR-220403 The IKS event recognition functionality shall be a semantic service.NFR-220404 The IKS entity recognition functionality shall be a semantic service.NFR-220405 The IKS shall provide different recognition alorithms for different users.UC-230402UC-230403UC-230404UC-230405UC-230413UC-230414UC-230415UC-230416© IKS Consortium2010

142 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case3.5 HLR-2305: Content EnrichmentHLR IDNameDescriptionClassificationDomainsRelatedrequirementsHLR-2305Content EnrichmentIKS should be able to retrieve additional information to specific contentitems. This information should be extracted from the correspondingCMS or from external sources. Using these information the existingcontent created by the user can be automatically enriched, e.g. by referencesto academic papers, attachment of images or video files etc..Vertical“Portal market for travel agencies”,“News market for journalists´ teams”HLR-23043.5.1 ScenariosScenario 1 - Portal market for travel agencies (Semantic enrichment of content):To provide additional information about products (e.g. hotels, trips, etc.) or travel areas theuser is browsing, it should be possible to automatically enrich these information. Additionalinformation, like events, activities or historical facts should be provided depending on thecontent the user is browsing.© IKS Consortium2010

143 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 58: Use case diagram for HLR-2305 scenario 1Scenario 2 - Portal market for travel agencies (Verification of retrieval sources):While enriching existing content with additional information, data from corrupted sources areretrieved. Furthermore no security protocols have been followed. Thereby even the existingcontent in the CMS can be corrupted permanently. In order to ensure, a high level of qualityand security regarding the content presented to the end-user, only verified or certified contentsources are used for the retrieval of content.© IKS Consortium2010

144 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 59: Use case diagram for HLR-2305 scenario 2Scenario 3 - News market for journalists’ teams (Enriching content with informationretrieved from internal sources):A journalist is working on an article about a famous football player. He remembers that comparablearticles have already been written by his colleagues using the same CMS. In order toenrich his own content existing information from other internal source are retrieved.© IKS Consortium2010

145 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 60: Use case diagram for HLR-2305 scenario 3Scenario 4 - News market for journalists’ teams (Enriching content with informationretrieved from external sources):Using the extraction technologies described in HLR-2304, the sports journalist identifies aplayer on a photo or a video about a football game. Using the extracted information, additionalinformation is gathered from external sources enriching the existing content in theCMS.© IKS Consortium2010

146 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 61: Use case diagram for HLR-2305 scenario 43.5.2 Use Case DescriptionsUC-230501: Provide related content [SC3]UC-230502: Automatic content enrichment [SC1]UC-230503: Browsing enriched content [SC1]UC-230504: Internal content enrichment [SC3]UC-230505: External content enrichment [SC4]UC-230506: Define list of trustable certificates [SC2]UC-230507: Present enriched content to consumer [SC1, SC3, SC4]© IKS Consortium2010

147 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230508: Perform content enrichment [SC1, SC3, SC4]UC-230509: Identify preferences and interests [SC1]UC-230510: Enrich content with retrieved information [SC1, SC3, SC4]UC-230511: Retrieve external related content [SC1, SC2, SC4]UC-230512: Analyze content browsed by consumer [SC1]UC-230513: Check certificates of proposed sources [SC2]UC-230514: Retrieve internal related content [SC3]Use cases from other HLRs UC-230101: Send IKS service request [SC1,SC3,SC4] UC-230111: Execute [SC1,SC3,SC4]UC-230501: Provide related contentUse Case ID UC-230501: Provide related content [SC3]Description Performing the retrival of content for internal content enrichment, the CMSmust provide the content to the IKS enrichment service.Parent ---Extensions ---Includes ---Scope Internal content enrichmentActor(s) CMSGoal The required content is provided to the IKS service.Trigger The internal content enrichment service is performed and the data is requestedfrom the CMS.UC-230502: Automatic content enrichmentUse Case ID UC-230502: Automatic content enrichment [SC1]Description The automatic content enrichment is not triggered by the consumer but by theCMS system itself. The system should be able to enrich the content before orwhile the consumer is browsing the presented content. According to thecontent the consumer is interested in, additional information of the same topic,domain or subject are automatically retrieved and used for enrichment.Parent UC-230101Extensions ---Includes UC-230508© IKS Consortium2010

148 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionScope Content enrichmentActor(s) CMSGoal The content browsed by the consumer is automatically enriched by performinga IKS service.Trigger The automatic enrichment is not explicitly triggered but performed as a kidn ofbackground service.Figure 62: Activity diagram for use case UC-230502UC-230503: Browsing enriched contentUse Case ID UC-230503: Browsing enriched content [SC1]Description The content enriched by the automatic content enrichment service is presentedto the consumer. The consumer can browse in this enriched content.© IKS Consortium2010

149 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---Includes ---Scope Content presentationActor(s) ConsumerGoal The consumer can browse in content which has been enriched addressing hispersonal preferences and interests.Trigger The consumer is interested in specific content and browses in it.UC-230504: Internal content enrichmentUse Case ID UC-230504: Internal content enrichment [SC3]Description The internal content enrichment is requested by the consumer to enrichexisting content with references or direct embedding of related content items.Addressing content that is stored in the same CMS the performed IKS serviceretrieves internal content.Parent ---Extensions ---Includes UC-230508Scope Internal enrichmentActor(s) ConsumerGoal The content is enriched by available internal information provided by theperformed IKS service.Trigger The consumer working on the content starts the internal content enrichmentservice.© IKS Consortium2010

150 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 63: Activity diagram for use case UC-230504UC-230505: External content enrichmentUse Case ID UC-230505: External content enrichment [SC4]Description The external content enrichment is requested by the consumer to enrichexisting content with references or direct embedding of related content items.Addressing content that is stored in external systems and databases theperformed IKS service retrieves external content.Parent ---Extensions ---Includes UC-230508Scope External enrichmentActor(s) Consumer© IKS Consortium2010

151 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionGoal The content is enriched by external information provided by the performed IKSservice.Trigger The consumer working on the content starts the external content enrichmentservice.Figure 64: Activity diagram for use case UC-230505UC-230506: Define list of trustable certificatesUse Case ID UC-230506: Define list of trustable certificates [SC2]Description The trustability of external source is checked by certificates of these sources.In order to ensure, that only verified sources are used by the IKS contentenrichment services, the IKS customizer defines a list of trustable certificates.Parent ---Extensions ---© IKS Consortium2010

152 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseIncludes ---Scope Security certificatesActor(s) IKS CustomizerGoal A list of trustable certificates is defines by which content source can beverified.Trigger ---UC-230507: Present enriched content to consumerUse Case ID UC-230507: Present enriched content to consumer [SC1, SC3, SC4]Description The content enrichment service of the IKS is able to provide additionalinformation for existing content. These results of the enrichment should bepresented to the consumer in an appropriate format.Parent ---Extensions ---Includes ---Scope Content presentationActor(s) IKSGoal The enriched content is presented to the consumer.Trigger The IKS content enrichment service has been performed and provided theenriched content as result.Preconditions1. The IKS content enrichment service has been performed successfully and the additionalinformation are available.Minimal Postconditions1. The service provides a status response and the retrieved information is still available.Success Postconditions1. The enriched content is presented to the consumer in an appropriate form.© IKS Consortium2010

153 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230508: Perform content enrichmentUse Case ID UC-230508: Perform content enrichment [SC1, SC3, SC4]Description The content enrichment itself is performed by executing the IKS service.Parent ---Extensions Auto enrichment: UC-230509Includes UC-230512Scope Content enrichmentActor(s) IKS ServiceGoal The content enrichment is performed.Trigger The consumer starts the enrichment or the CMS performs the automaticalenrichment service.© IKS Consortium2010

154 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 65: Activity diagram for use case UC-230508UC-230509: Identify preferences and interestsUse Case ID UC-230509: Identify preferences and interests [SC1]© IKS Consortium2010

155 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseDescription Analyzing the content browsed by the consumer, his preferences and interestshould be derived. Therefore the automatic content enrichment can retrieveinformation addressing these interests.Parent ---Extensions ---Includes ---Scope Automatic content enrichmentActor(s) IKS ServiceGoal The preferences and interests of the consumer are identified.Trigger The automatic enrichment service is performed.UC-230510: Enrich content with retrieved informationUse Case ID UC-230510: Enrich content with retrieved information [SC1, SC3, SC4]Description After retrieving related information, the content should be enriched with thisinformation. There will be three different kinds of enrichment:1. The additional information are referenced, so that the consumer canfollow this links.2. The retrieved content is explicitly presented as additionalinformation3. The additional information is directly embedded into the contentitem which is enriched.Parent ---Extensions ---Includes ---Scope Content enrichmentActor(s) IKS ServiceGoal The content is enriched with the retrieved information.Trigger The content enrichment service is performed.UC-230511: Retrieve external related contentUse Case ID UC-230511: Retrieve external related content [SC1, SC2, SC4]© IKS Consortium2010

156 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseDescription In order to provide a maximal range of content addressed by the retrievingservice, external sources should be searched. Therefore IKS service retrievesinformation related to the content from external sources. Ensuring the validityof the data retrieved from 3 rd party sources, the certifications of these sourceare checked for trustability.Parent ---Extensions ---Includes UC-230513Scope Information retrievalActor(s) IKS ServiceGoal Additional information is retrieved from external sources to enrich existingcontent.Trigger The IKS content enrichment service is performed for external enrichment.© IKS Consortium2010

157 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 66: Activity diagram for use case UC-230511© IKS Consortium2010

158 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230512: Analyze content browsed by consumerUse Case ID UC-230512: Analyze content browsed by consumer [SC1]Description The automatic enrichment is driven by the interest of the consumer browsingthe content. By analyzing the browsed content, the IKS service identifies inwhich additional information the consumer could be interested.Parent ---Extensions ---Includes UC-230509Scope Automatic content enrichmentActor(s) IKS serviceGoal The content browsed by the consumer is analyzed and his preferences andinterests have been identified.Trigger The IKS automatic content enrichment is performed.UC-230513: Check certificates of proposed sourcesUse Case ID UC-230513: Check certificates of proposed sources [SC2]Description The certificates of sources for external content enrichment are checked bycomparison to the list of trustable certificates.Parent ---Extensions ---Includes ---Scope Security certificatesActor(s) IKS ServiceGoal The certificates of external sources are checked for their trustability.Trigger The IKS service retrieves content from external sources.Preconditions1. ---© IKS Consortium2010

159 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseMinimal Postconditions1. The service provides a response with a protocol of the trustability check.Success PostconditionsMain Flow1. The certificates are successfully checked against the trustability lista. The source is classified as trustable and can be used for the retrieval of informationb. The source is not trustable and is not accessed by the IKS service1. ---Exceptions1. The trustability list can not be accessed and thereby it not possible to perform thecheck of the certificates.UC-230514: Retrieve internal related contentUse Case ID UC-230514: Retrieve internal related content [SC3]Description In order to provide a maximal range of content addressed by the retrievingservice, external sources should be searched. Therefore IKS service retrievesinformation related to the content from external sources. Ensuring the validityof the data retrieved from 3 rd party sources, the certifications of these sourceare checked for trustability.Parent ---Extensions ---Includes ---Scope Information retrievalActor(s) IKS ServiceGoal Additional information is retrieved from external sources to enrich existingcontent.Trigger The IKS content enrichment service is performed for external enrichment.© IKS Consortium2010

160 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 67: Activity diagram for use case UC-230514© IKS Consortium2010

161 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case3.5.3 Resulting Requirements DescriptionFunctional RequirementsID Requirement UC-RefFR-230501 The IKS shall support the automatic content enrichment.FR-230502 The IKS shall support the internal content enrichment.FR-230503 The IKS shall support the external content enrichment.FR-230504 The IKS shall support the definition of trustable certificates.FR-230505 The list of trustable certificates shall be customizable.UC-230502UC-230504UC-230505UC-230506UC-230506FR-230506 The IKS shall provide the presentation of enriched content to the consumer. UC-230507FR-230507 The IKS shall be able to identify preferences and interests from the userprofile.FR-230508 The IKS shall support the enrichment of content with retrieved information.FR-230509 The IKS shall be able to retrieve information from external sources.FR-230510 The IKS shall be able to retrieve information from internal sources.FR-230511 The IKS shall be able to validate the certificates of external sources for theirtrustability.FR-230512 The IKS shall be able to analyze the content browsed by the user.UC-230509UC-230510UC-230511UC-230514UC-230513UC-230512Integration requirementsID Requirement UC-RefINR-230501 The IKS shall be able to access related content stored in a CMS.INR-230502 The IKS shall be able to retrieve data from external data provider usingsecure connections.UC-230501UC-230511Interface requirementsID Requirement UC-RefIR-230501 The IKS should be able to process the data retrieved from external sources. UC-230505IR-230502 The IKS should be able to process the data retrieved from internal sources. UC-230504Non functional requirementsID Requirement UC-RefNFR-230501 The IKS content enrichment functionality shall be a semantic service.UC-230508© IKS Consortium2010

162 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case3.6 HLR-2306: Personalized content search assistanceHLR IDNameDescriptionClassificationDomainsHLR-2306Personalized content search assistanceEfficient search capabilities in CMS are essential for the interaction ofthe user with the content. Supporting the user in searching contentshould be addressed by usable assistance mechanisms. On the onehand the search itself should be adapted to the user preferences. Onthe other hand the user should be supported querying the search request.Vertical“Portal market for travel agencies”Relatedrequirements3.6.1 ScenariosScenario 1 (Personalized Search):The father of a family is searching for an appropriate holiday house for a trip. After registeringas a user, he can define a profile with personal information like relationship status, number ofchildren etc.. He starts the search for holiday houses and querying a simple search string like“Holiday houses, Italy”. According to his specific needs the search results focus on criterialike children rooms, childcare, non-smoking rooms, etc..© IKS Consortium2010

163 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 68: Use case diagram for HLR-2306 scenario 1Scenario 2 (Multilingual searching assistant):A user is looking for holiday information but does not have a concrete idea which kind of triphe would like to do. He activates the intelligent search assistant. By asking questions to theuser the system analyses preferences and provides a selection of appropriate offers to him.© IKS Consortium2010

164 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 69: Use case diagram for HLR-2306 scenario 2Scenario 3 (Natural language search):Instead of searching by specific categories or the question-based search assistant describedin scenario 2, the user just specifies his query in natural language (e.g.: “I would like to enjoymy holidays with my family in a spacious holiday apartment”). According to this query a list ofsearch results is presented to the user.© IKS Consortium2010

165 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFigure 70: Use case diagram for HLR-2306 scenario 33.6.2 Use Case DescriptionsUC-230601: Register with user profile [SC1]UC-230602: Enter search query [SC2]UC-230603: Set preferred language [SC2]UC-230604: Select answer for question by search assistant [SC2]© IKS Consortium2010

166 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230605: Enter search request in natural language [SC3]UC-230606: Personalized search [SC1]UC-230607: Search assistance [SC2]UC-230608: Natural language search [SC3]UC-230609: Perform personalized search [SC1]UC-230610: Perform search assistance [SC2]UC-230611: Perform natural language search [SC3]UC-230612: Set search parameterization [SC1]UC-230613: Search content [SC1]UC-230614: Interpret search query [SC1]UC-230615: Analyze selected answer [SC2]UC-230616: Create question with alternative answers [SC2]UC-230617: Derive search query from natural language [SC3]UC-230618: Analyze natural language [SC3]Use cases from other HLRs UC-230101: Send IKS service request [SC1,SC3,SC4] UC-230111: Execute [SC1,SC3,SC4]UC-230601: Register with user profileUse Case ID UC-230601: Register with user profile [SC1]Description The user can create an account with describing profile with personal data.When he is logged in and searches for content, the prefenences and interestdefined in his profile are used to parameterize the search.Parent ---Extensions ---Includes ---Scope User profileActor(s) ConsumerGoal The consumer is registered as user and creates a personal user profile.Trigger The consumer wants to use the personlized search capabilities.UC-230602: Enter search queryUse Case ID UC-230602: Enter search query [SC2]Description The consumer is interested in a specific content. By entering a search queryhe specifies which content he is looking for. The syntax of the query iscomparable to existing search engines like google, yahoo, etc..© IKS Consortium2010

167 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent ---Extensions ---Includes ---Scope Search queryActor(s) ConsumerGoal The consumer enters a syntactical correct search query.Trigger The consumer wants to search for a specific content.UC-230603: Set preferred languageUse Case ID UC-230603: Set preferred language [SC2]Description The search assistant provide a multi-language support for the questions. Theconsumer set the preferred language.Parent ---Extensions ---Includes ---Scope Search assistanceActor(s) ConsumerGoal The consumer sets the language he would prefer for the search assistance.Trigger The consumer wants to set a language which is different from the defaultspecified language.Preconditions1. ---Minimal Postconditions1. The consumer gets a status response.Success PostconditionsMain Flow1. The consumer set the language for the search assistance service.1. ---© IKS Consortium2010

168 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExceptions1. The language selected by the consumer is not supported by the search assistanceservice.UC-230604: Select answer for question by search assistantUse Case ID Select answer for question by search assistant [SC2]Description The search assistance ask question with a selection of alternative answers.The consumer selects the most appropriate answer to the correspondingquestion.Parent ---Extensions ---Includes ---Scope Search assistanceActor(s) ConsumerGoal The user has selected the answer.Trigger The search assistance is performed.UC-230605: Enter search request in natural languageUse Case ID UC-230605: Enter search request in natural language [SC3]Description Instead of specifying the search request in a formal query syntax, the userdescribes the search request as a question in natural language.Parent ---Extensions ---Includes ---Scope Natural language searchActor(s) ConsumerGoal The consumer enters the search request in natural language.Trigger The consumer wants to search for content using the natural language search.© IKS Consortium2010

169 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230606: Personalized searchUse Case ID UC-230606: Personalized search [SC1]Description A registered user who searches for content, should get search resultsmatching his personal preferences. Therefore the search results will focus oncontent and information which are related to the information in the user profile.Parent UC-230101Extensions ---Includes UC-230609Scope Personalized SearchActor(s) ConsumerGoal The consumer searches for content and a personalized result addressing hispreferences is provided by the IKS search service.Trigger The consumer starts the personalized search and the corresponding IKSservice is performed.© IKS Consortium2010

170 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 71: Activity diagram for use case UC-230606UC-230607: Search assistanceUse Case ID UC-230607: Search assistance [SC2]Description The search assistance service provides an alternative approach for theconsumer of searching for content. Instead of entering a query, the user canfollow the question-based search assistant in order to find relevant content.Parent ---Extensions ---Includes UC-230610Scope Search assistanceActor(s) Consumer© IKS Consortium2010

171 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionGoal The search assistance is started and the IKS service is executed.Trigger The customer starts the search assistance.Figure 72: Activity diagram for use case UC-230607UC-230608: Natural language search [SC3]Use Case ID UC-230608: Natural language search [SC3]Description The natural language search service provides a approach for the consumer ofsearching for content. Instead of entering a query, the user enters the searchrequest in a natural language question. The IKS service identifies keywordsand their relations and performs the search for relevant content.Parent ---Extensions ---Includes UC-230611© IKS Consortium2010

172 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseScope Natural language searchActor(s) ConsumerGoal The natural language search is started and the IKS service is executed.Trigger The customer starts the natural language search.ActionFigure 73: Activity diagram for use case UC-230608UC-230609: Perform personalized searchUse Case ID UC-230609: Perform personalized search [SC1]Description The personalized search itself is performed by executing the IKS service.Parent UC-230111© IKS Consortium2010

173 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExtensions Parameterization: UC-230612Includes UC-230613UC-230614Scope Personalized searchActor(s) IKS ServiceGoal The personalized search is performed.Trigger The consumer starts personalized search and the IKS service is called.© IKS Consortium2010

174 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 74: Activity diagram for use case UC-230609UC-230610: Perform search assistanceUse Case ID UC-230610: Perform search assistance [SC2]Description The search assistance itself is performed by executing the IKS service.© IKS Consortium2010

175 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseParent UC-230111Extensions ---Includes UC-230615UC-230616Scope Search assistanceActor(s) IKS ServiceGoal The search assistence is performed.Trigger The consumer starts the search assistence and the IKS service is called.© IKS Consortium2010

176 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 75: Activity diagram for use case UC-230610© IKS Consortium2010

177 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseUC-230611: Perform natural language searchUse Case ID UC-230611: Perform natural language search [SC3]Description The natural language search itself is performed by executing the IKS service.Parent UC-230111Extensions ---Includes UC-230618Scope Natural language searchActor(s) IKS ServiceGoal The natural language search is performed.Trigger The consumer starts the natural language search and the IKS service is called.© IKS Consortium2010

178 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseActionFigure 76: Activity diagram for use case UC-230611UC-230612: Set search parameterizationUse Case ID UC-230612: Set search parameterization [SC1]Description The personalized search should address the preferences of the consumer.© IKS Consortium2010

179 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseThereby the search is parameterized with informations from the user profile.Parent ---Extensions ---Includes ---Scope Personalized searchActor(s) IKS ServiceGoal The search is parameterized according to the user profile.Trigger The personalized search is performed.UC-230613: Search contentUse Case ID UC-230613: Search content [SC1]Description The search for content requested by the consumer is performed.Parent ---Extensions ---Includes ---Scope Personalized searchActor(s) IKS serviceGoal Relevant content is searched with respect to the defined parameterization.Trigger The personalized search is performed.UC-230614: Interpret search queryUse Case ID UC-230614: Interpret search query [SC1]Description The search query requesting the search service is interpreted by the IKSengine.Parent ---Extensions ---Includes ---© IKS Consortium2010

180 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseScope Personalized searchActor(s) IKS ServiceGoal The search query is interpreted successfully.Trigger The personalized search is performed.UC-230615: Analyze selected answerUse Case ID UC-230615: Analyze selected answer [SC2]Description The questions are answered from the user by selecting given answers. Theseanswers are analyzed in order to derive further questions or a list of relevantcontent.Parent ---Extensions ---Includes ---Scope Search assistanceActor(s) IKS ServiceGoal The selected answers are analyzed by the IKS service.Trigger The search assistence is performed and the consumer has answered the givenquestions.Preconditions1. The question has been answered by the user.Minimal Postconditions1. The service provides a status response to the user.Success PostconditionsMain Flow1. The answers are analyzed successfully.1. Questions are provided to the user.2. Answers are selected by the user.3. The answers are analyzed.4. Are the given answers sufficient for the search of relevant content?a. Yes: Call presentation service.b. No: Create new question, with respect to given answers.© IKS Consortium2010

181 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseExceptions1. ---UC-230616: Create question with alternative answersUse Case ID UC-230616: Create question with alternative answers [SC2]Description In order to assist the user in searching content, questions regarding hisinterests are asked to him. The questions with answers have to be selectedaccording to the answers already given by the user.Parent ---Extensions ---Includes ---Scope Search assistanceActor(s) IKS serviceGoal Questions with alternative answers are created.Trigger The search assistance is performed.UC-230617: Derive search query from natural languageUse Case ID UC-230617: Derive search query from natural language [SC2]Description The natural language in which the customer enters the search request must be“translated” into a processable format. Therefore a formal search query isderived from the natural language request.Parent ---Extensions ---Includes ---Scope Natural language searchActor(s) IKS ServiceGoal A formal query is created from the informal natural language request.Trigger The natural language search is performed.Preconditions1. The customer specified a request in natural language.© IKS Consortium2010

182 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseMinimal Postconditions1. The service provides a status response to the user.Success PostconditionsMain Flow1. A formal search query is derived from the natural language request.1. ---Exceptions1. No query can be derived from requesta. Invalid semantic structure of natural language requestUC-230618: Analyze natural languageUse Case ID UC-230618: Analyze natural language [SC3]Description The natural language request is analyzed for further processing by the searchengine.Parent ---Extensions ---Includes ---Scope Natural language searchActor(s) IKS serviceGoal The request is analyzed and a search query can be derived using the result ofthe analysis.Trigger The natural language search is performed.3.6.3 Resulting Requirements DescriptionFunctional RequirementsID Requirement UC-RefFR-230601 The IKS shall support the creation of user profiles with personal data.FR-230602 The IKS should provide a multilingual support for the search assistant.FR-230603 The IKS should support personalized search.UC-230601UC-230603UC-230609© IKS Consortium2010

183 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement UC-RefFR-230604 The IKS should support search assistance.FR-230605 The IKS should support natural language search.FR-230606 The search shall be parameterisable by information from the user profile.FR-230607 The IKS shall be able to create question and alternative answers to identifyrelevant content for the user.FR-230608 The IKS shall be able to derive a search query from a natural languagesearch request.UC-230610UC-230611UC-230609UC-230610UC-230611Interface requirementsID Requirement UC-RefIR-230601 The IKS shall be able to process search queries.IR-230602 The IKS shall be able to process the answers given from the user to thesearch assistant.IR-230603 The IKS shall be able to process search queries in natural language.UC-230602UC-230604UC-230605Non functional requirementsID Requirement UC-RefNFR-230601 The languages supported by the IKS search assistant should expandible. UC-230603NFR-230602 The IKS personalized search functionality shall be a semantic service. UC-230606NFR-230603 The IKS search assistance functionality shall be a semantic service. UC-230607NFR-230604 The IKS natural language search functionality shall be a semantic service. UC-230608© IKS Consortium2010

184 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case4 Summary and Further StepsThe main outcome of this deliverable is the specification of about 125 requirements for threevertical industrial use cases. Addressing the high-level goals from three different perspectives,these requirements reflect the needs from different domains. By using a well-definedrequirements specification process the elicited requirements can directly be related to thecorresponding use cases and scenarios. In the next step the requirements from the verticaluse case are consolidated against the requirements from the horizontal use case describedin Deliverable 2.2. During the consolidation, each requirement elicited in task 2.3 will bemarked as either domain-specific or general (i.e. horizontal).Task 4.3. and task 6.2 in the IKS project have dependencies with the results from this specification:In task 4.3 “Vertical industrial case: Design and Implementation” the design and implementationfor the specified requirements is done. The validation of the designed andimplemented solution will be done as part of task 6.2. “Validation of IKS through use caseapplication developers”.In IKS, work package 2 and 3, together with task 1.3 from work package 1 have led to definitionsof requirements. During the design of the initial version of the IKS Stack all of these requirementsneed to be consolidated. The consolidated requirements will be reported in thespecification documents of WP 4 and WP 5: Design and Implementation of the Use Casesand the IKS Stack, respectively.5 ReferencesIEEE1998IEEE1998aChrist2009RFC1997Posch2004Pixelio2010IEEE Recommended Practice for Software Requirements Specification.IEEE Std. 830-1998. IEEE Computer Society. June 1998.IEEE Recommended Practice for Software Test Documentation. IEEEStd. 829-1998. IEEE Computer Society. 1998.Fabian Christ, Gregor Engels, Stefan Sauer, Gokce B. Laleci, Erdem Alpay,Tuncay Namli, Ali Anil Sinaci, Fulya Tuncer, 2009: IKS Deliverable.D2.2 Report:Requirements Specification for the Horizontal Industrial Case.Bradner, S. Key words for use in RFCs to Indicate Requirement Levels.BCP 14, RFC 2119. March 1997.Posch, Torsten; Birken, Klaus und Gerdom, Michael: Basiswissen Softwarearchitektur.1. Auflage, dpunkt.verlag: 2004.http://www.pixelio.de/(visited at 17.05.2010)Tourism Network 2010http://www.tourismknowledge.com/© IKS Consortium2010

185 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case6 Annex6.1 Final requirements listingsIn this section the requirements elicited in the vertical industrial use case are summarized.According to the requirements engineering approached used in this deliverable, this list ofrequirements is categorized as follows: Functional requirements Data requirements Integration requirements Interface requirements Non-functional requirementsThe requirements listed in this summary are described by using the following attributes:• IDA unique identifier for the requirement. It will be composed of three parts: “R”+”Type ofrequirement – “+“enumerator”• RequirementThe explanation of the requirement.• Referred UCIndicates the corresponding use case from technical point of view.• DomainIndicates from which domain the requirement has been derived:SE - Software EngineeringNM - News market for journalists´ teamsPM - Portal market for travel agencies• HLRIndicates which high level requirements it belongs to.6.1.1 Functional RequirementsID Requirement Referred UC Domain HLRHLR-2301: Content clusteringFR-230101The IKS shall support the definition UC-230102 SE HLR-2301:of scopes of relevant content for theContent clusteringclustering.FR-230102The IKS shall be able to assigncreated content to an existingcontent cluster.UC-230105 SE HLR-2301:Content clusteringFR-230103The clustering rules used by the IKS UC-230107 SE HLR-2301:shall be configurable.Content clustering© IKS Consortium2010

186 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement Referred UC Domain HLRFR-230104FR-230105FR-230106FR-230107FR-230107FR-230108FR-230109FR-230110FR-230111FR-230112FR-230113FR-230114FR-230115FR-230116FR-230117FR-230118The labeling methodology used byIKS shall be parameterisable.The flat clustering performed by theIKS shall be customizable.The IKS shall be able to present theresults of the clustering.The IKS shall be able to build flatcontent clusters.The IKS shall be able to labelcontent clusters.The IKS shall support clusterinternallabelling.The IKS shall support differentialcluster labelling.The IKS shall be able to calculatethe distance measure betweencontent items.UC-230108 SE HLR-2301:Content clusteringUC-230109UC-230119SEHLR-2301:Content clusteringUC-230110 SE HLR-2301:Content clusteringUC-230113 SE HLR-2301:Content clusteringUC-230114 SE HLR-2301:Content clusteringUC-230115 SE HLR-2301:Content clusteringUC-230116 SE HLR-2301:Content clusteringUC-230117 SE HLR-2301:Content clusteringThe hierarchical clustering algorithm UC-230118 SE HLR-2301:processed by the IKS shall beContent clusteringcustomizable.The IKS shall be able to buildhierarchical content clusters.The IKS shall be able to processhierarchical clustering algorithms.The IKS shall support divisiveclustering algorithms.UC-230120 SE HLR-2301:Content clusteringUC-230121 SE HLR-2301:Content clusteringUC-230122 SE HLR-2301:Content clusteringThe IKS shall support agglomerative UC-230123 SE HLR-2301:clustering algorithms.Content clusteringThe IKS shall be able to calculatethe matching to existing clusters.The IKS shall be able to suggestmatching clusters to createdcontent.The IKS clustering shall beperformed by processing theclustering features.HLR-2302: Traceability among content itemsFR-230201 The IKS shall be able to interpretdefined linking rules.FR-230202 The IKS shall be able to recognizethe type of relation between contentitems.UC-230124 SE HLR-2301:Content clusteringUC-230125 SE HLR-2301:Content clusteringUC-230112 SE HLR-2301:Content clusteringUC-230215 SE HLR-2302:Traceabilityamong contentitemsUC-230216 SE HLR-2302:Traceabilityamong contentitems© IKS Consortium2010

187 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement Referred UC Domain HLRFR-230203 The IKS shall be able toautomatically create links betweencontent items.UC-230217 SE HLR-2302:Traceabilityamong contentitemsFR-230204 The IKS shall be able to automatical UC-230219 SE HLR-2302:create links between cross-typecontent items.Traceabilityamong contentitemsFR-230205 The IKS shall be able to analyze the UC-230221 SE HLR-2302:relation between content items.Traceabilityamong contentitemsFR-230206 The IKS shall be able to set linksbetween content items.FR-230207 The IKS shall be able to analyzetextual content items.FR-230208 The IKS shall be able to analyzenon-textual content items.FR-230209 The IKS shall provide a linksuggestionto existing contentitems.FR-230210 The IKS shall provide the creationof linking rules.FR-230211 The creation of links shall beconfigurable by linking rules.HLR-2303: Calculation of correlation among contentUC-230220 SE HLR-2302:Traceabilityamong contentitemsUC-230222 SE HLR-2302:Traceabilityamong contentitemsUC-230223 SE HLR-2302:Traceabilityamong contentitemsUC-230223 SE HLR-2302:Traceabilityamong contentitemsUC-230211 SE HLR-2302:Traceabilityamong contentitemsUC-230225 SE HLR-2302:Traceabilityamong contentitemsFR-230301 The IKS shall be able to calculatethe similarity between content itemsUC-230305 SE HLR-2303:Calculation ofcorrelation amongcontentFR-230302 The IKS shall be able to check the UC-230306 SE HLR-2303:similarity rating against a predefinedthreshold.Calculation ofcorrelation amongcontentFR-230303 The IKS shall be able to present alist of suggested duplicates.UC-230507 SE HLR-2303:Calculation ofcorrelation amongcontent© IKS Consortium2010

188 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFR-230304 The IKS shall support the duplicatechecking for content items.FR-230305 The IKS shall support the similaritycheck.UC-230504 SE HLR-2303:Calculation ofcorrelation amongcontentUC-230501 SE HLR-2303:Calculation ofcorrelation amongcontentFR-230306 The IKS shall be able to present the UC-230311 SE HLR-2303:results in a ranked list.Calculation ofcorrelation amongcontentFR-230307 The IKS shall be able to calculatethe degree of similarity betweencontent items.HLR-2304: Information ExtractionFR-230401 The IKS shall support facerecognition.FR-230402 The IKS shall support locationrecognition.FR-230403 The IKS shall support eventrecognition.FR-230404 The IKS shall support entityrecognition.FR-230405 The IKS shall provide a reusablepresentation of extracted data.FR-230406 The IKS shall be able toautomatically generate a highlightselection by the event recognition.FR-230407 The IKS shall provide the capabilityto define biometrical algorithms forface recognition.FR-230408 The IKS shall provide the capabilityto define recognition algorithms fordifferent types of locations.FR-230409 The IKS shall provide the capabilityto define recognition algorithms fordifferent types of events.FR-230410 The IKS shall provide the capabilityto define recognition algorithms fordifferent entities.UC-230305 SE HLR-2303:Calculation ofcorrelation amongcontentUC-230402 NM HLR-2304:InformationExtractionUC-230403 NM HLR-2304:InformationExtractionUC-230404 NM HLR-2304:InformationExtractionUC-230405 NM HLR-2304:InformationExtractionUC-230411 NM HLR-2304:InformationExtractionUC-230412 NM HLR-2304:InformationExtractionUC-230413 NM HLR-2304:InformationExtractionUC-230414 NM HLR-2304:InformationExtractionUC-230415 NM HLR-2304:InformationExtractionUC-230416 NM HLR-2304:InformationExtraction© IKS Consortium2010

189 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFR-230411 The IKS shall be able to loadcontent items from a CMS to theanalysis engine.FR-230412 The IKS shall be identify the type ofa content item.FR-230413 The IKS shall support the analysisof photos for the face recognition.FR-230414 The IKS shall support the analysisof video streams for the face,location and event recognition.FR-230415 The IKS shall support the analysisof textual content items for therecognition of entities.FR-230416 The IKS shall be able to identifyfaces in photographs.FR-230417 The IKS shall be able to identifyfaces in video streams.FR-230418 The IKS shall be able to extractbiometrical data from visual contentitems.FR-230419 The IKS shall be able to extractlocation data from video streams.FR-230420 The IKS shall be able to extractdefined entities and informationfrom texts.FR-230421 The IKS shall be able to extractevent data from video streams.FR-230422 The IKS shall be able to marktimestamps of events in videostreams.HLR-2305: Content EnrichmentUC-230417UC-230418UC-230419UC-230420NMHLR-2304:InformationExtractionUC-230417 NM HLR-2304:InformationExtractionUC-230421 NM HLR-2304:InformationExtractionUC-230422 NM HLR-2304:InformationExtractionUC-230423 NM HLR-2304:InformationExtractionUC-230424 NM HLR-2304:InformationExtractionUC-230425 NM HLR-2304:InformationExtractionUC-230426 NM HLR-2304:InformationExtractionUC-230427 NM HLR-2304:InformationExtractionUC-230428 NM HLR-2304:InformationExtractionUC-230429 NM HLR-2304:InformationExtractionUC-230430 NM HLR-2304:InformationExtractionFR-230501 The IKS shall support the automatic UC-230502 PM HLR-2305:content enrichment.ContentEnrichmentFR-230502 The IKS shall support the internalcontent enrichment.FR-230503 The IKS shall support the externalcontent enrichment.UC-230504 NM HLR-2305:ContentEnrichmentUC-230505 NM HLR-2305:ContentEnrichment© IKS Consortium2010

190 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFR-230504 The IKS shall support the definitionof trustable certificates.UC-230506 PM HLR-2305:ContentEnrichmentFR-230505 The list of trustable certificates shall UC-230506 PM HLR-2305:be customizable.ContentEnrichmentFR-230506 The IKS shall provide thepresentation of enriched content tothe consumer.FR-230507 The IKS shall be able to identifypreferences and interests from theuser profile.FR-230508 The IKS shall support theenrichment of content with retrievedinformation.FR-230509 The IKS shall be able to retrieveinformation from external sources.FR-230510 The IKS shall be able to retrieveinformation from internal sources.UC-230507 NM, PM HLR-2305:ContentEnrichmentUC-230509 PM HLR-2305:ContentEnrichmentUC-230510 NM, PM HLR-2305:ContentEnrichmentUC-230511 NM, PM HLR-2305:ContentEnrichmentUC-230514 NM HLR-2305:ContentEnrichmentFR-230511 The IKS shall be able to validate the UC-230513 PM HLR-2305:certificates of external sources forContenttheir trustability.EnrichmentFR-230512 The IKS shall be able to analyze the UC-230512 PM HLR-2305:content browsed by the user.ContentEnrichmentHLR-2306: Personalized content search assistanceFR-230601 The IKS shall support the creationof user profiles with personal data.FR-230602 The IKS should provide amultilingual support for the searchassistant.FR-230603 The IKS should supportpersonalized search.FR-230604 The IKS should support searchassistance.FR-230605 The IKS should support naturallanguage search.UC-230601 PM HLR-2306:Personalizedcontent searchassistanceUC-230603 PM HLR-2306:Personalizedcontent searchassistanceUC-230609 PM HLR-2306:Personalizedcontent searchassistanceUC-230610 PM HLR-2306:Personalizedcontent searchassistanceUC-230611 PM HLR-2306:Personalizedcontent searchassistance© IKS Consortium2010

191 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseFR-230606 The search shall beparameterisable by information fromthe user profile.FR-230607 The IKS shall be able to createquestion and alternative answers toidentify relevant content for theuser.FR-230608 The IKS shall be able to derive asearch query from a naturallanguage search request.UC-230609 PM HLR-2306:Personalizedcontent searchassistanceUC-230610 PM HLR-2306:Personalizedcontent searchassistanceUC-230611 PM HLR-2306:Personalizedcontent searchassistanceData requirementsID Requirement Referred UC Domain HLRHLR-2301: Content clusteringDR-230101The IKS shall be able to handle aservice request and to send back aresponse.HLR-2302: Traceability among content itemsDR-230201The IKS shall provide the results ofthe automatic linking in a reusableformat.HLR-2304: Information ExtractionDR-230401DR-230402DR-230403The IKS shall be able to processtexts in common standard formats.The IKS shall be able to processvideo streams in commonmultimedia standard formats.The IKS shall be able to processphotographs in common grahicalstandard formats.UC-230201 SE HLR-2301:Content clusteringUC-230214 SE HLR-2302:Traceability amongcontent itemsUC-230423 NM HLR-2304:InformationExtractionUC-230422 NM HLR-2304:InformationExtractionUC-230421 NM HLR-2304:InformationExtractionIntegration requirementsID Requirement Referred UC Domain HLRHLR-2301: Content clusteringINR-230101The automatic labelling of contentclusters shall be customizable byparameterising custom labellingstrategies.UC-230208 SE HLR-2301:Content clustering© IKS Consortium2010

192 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement Referred UC Domain HLRINR-230102INR-230103The automatic flat clustering shall be UC-230209 SE HLR-2301:customizable by implementingContent clusteringcustom clustering strategies.The automatic hierachical clusteringshall be customizable byimplementing custom clusteringstrategies.HLR-2303: Calculation of correlation among contentINR-230301INR-230302UC-230218 SE HLR-2301:Content clusteringThe duplicates calculated by the IKS UC-230307 SE HLR-2303:service shall be presentable in theCMS.Calculation ofcorrelation amongcontentThe similarity calculated by the IKSservice shall be presentable in aCMS.HLR-2304: Information ExtractionINR-230401INR-230402The information recognized by theIKS services shall be storeable inthe CMSThe content store in the CMS whichshould be recognized shall byaccessable for the IKS.HLR-2305: Content EnrichmentINR-230501INR-230502The IKS shall be able to accessrelated content stored in a CMS.The IKS shall be able to retrievedata from external data providerusing secure connections.UC-230311 SE HLR-2303:Calculation ofcorrelation amongcontentUC-230401 NM HLR-2304:InformationExtractionUC-230402 NM HLR-2304:InformationExtractionUC-230501 NM HLR-2305:ContentEnrichmentUC-230511 NM, PM HLR-2305:ContentEnrichmentInterface requirementsID Requirement Referred UC Domain HLRHLR-2301: Content clusteringIR-230101IR-230102IR-230103IR-230104The IKS shall be able to processdefined content scopes.The IKS shall be able to processclustering rules.The IKS shall be able to processlabelling parameter.The IKS shall be able to processcreated content.HLR-2302: Traceability among content itemsUC-230102 SE HLR-2301:Content clusteringUC-230107 SE HLR-2301:Content clusteringUC-230108 SE HLR-2301:Content clusteringUC-230105 SE HLR-2301:Content clustering© IKS Consortium2010

193 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement Referred UC Domain HLRIR-230201IR-230202IR-230203The IKS shall be able to processdefined linking rules.The IKS shall be able to processlinking rules load from therepository.The links calculated in the IKS shallstorable in the CMS repository.HLR-2303: Calculation of correlation among contentIR-230301The IKS shall be able to processdefined similarity thresholds.HLR-2304: Information ExtractionIR-230401IR-230402IR-230403The IKS shall be able to processspecifications of location types to berecognized.The IKS shall be able to processspecifications of event types to berecognized.The IKS shall be able to processspecifications of entities to berecognized.HLR-2305: Content EnrichmentIR-230501IR-230502The IKS should be able to processthe data retrieved from externalsources.The IKS should be able to processthe data retrieved from internalsources.HLR-2306: Personalized content search assistanceIR-230601IR-230602IR-230603The IKS shall be able to processsearch queries.UC-230211 SE HLR-2302:Traceability amongcontent itemsUC-230203 SE HLR-2302:Traceability amongcontent itemsUC-230203 SE HLR-2302:Traceability amongcontent itemsUC-230301 SE HLR-2303:Calculation ofcorrelation amongcontentUC-230407 NM HLR-2304:InformationExtractionUC-230408 NM HLR-2304:InformationExtractionUC-230409 NM HLR-2304:InformationExtractionUC-230505 NM HLR-2305:ContentEnrichmentUC-230504 NM HLR-2305:ContentEnrichmentUC-230602 PM HLR-2306:Personalizedcontent searchassistanceThe IKS shall be able to process the UC-230604 PM HLR-2306:answers given from the user to thesearch assistant.Personalizedcontent searchassistanceThe IKS shall be able to processsearch queries in natural language.UC-230605 PM HLR-2306:Personalizedcontent searchassistance© IKS Consortium2010

194 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseNon functional requirementsID Requirement Referred UC Domain HLRHLR-2301: Content clusteringNFR-230101NFR-220102The IKS flat clustering shall be asemantic service.The IKS hierarchical clustering shallbe a semantic service.HLR-2302: Traceability among content itemsNFR-230201NFR-220202The IKS automatic linking shall besemantic service.The IKS auto-suggestion shall besemantic service.HLR-2303: Calculation of correlation among contentNFR-230301NFR-230302The IKS content duplicate checkshall be a semantic service.The IKS content similarity checkshall be a semantic service.HLR-2304: Information ExtractionNFR-230401NFR-220402NFR-220403NFR-220404NFR-220405The IKS face recognitionfunctionality shall be a semanticservice.The IKS location recognitionfunctionality shall be a semanticservice.The IKS event recognitionfunctionality shall be a semanticservice.The IKS entity recognitionfunctionality shall be a semanticservice.The IKS shall provide differentrecognition alorithms for differentusers.HLR-2305: Content EnrichmentNFR-230501The IKS content enrichmentfunctionality shall be a semanticservice.UC-230103 SE HLR-2301:Content clusteringUC-230104 SE HLR-2301:Content clusteringUC-230206 SE HLR-2302:Traceability amongcontent itemsUC-230209 SE HLR-2302:Traceability amongcontent itemsUC-230302 SE HLR-2303:Calculation ofcorrelation amongcontentUC-230308 SE HLR-2303:Calculation ofcorrelation amongcontentUC-230402 NM HLR-2304:InformationExtractionUC-230403 NM HLR-2304:InformationExtractionUC-230404 NM HLR-2304:InformationExtractionUC-230405 NM HLR-2304:InformationExtractionUC-230413UC-230414UC-230415UC-230416NMHLR-2304:InformationExtractionUC-230508 NM,PM HLR-2305:ContentEnrichment© IKS Consortium2010

195 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use CaseID Requirement Referred UC Domain HLRHLR-2306: Personalized content search assistanceNFR-230601NFR-230602NFR-230603NFR-230604The languages supported by the IKS UC-230603 PM HLR-2306:search assistant should expandible.Personalizedcontent searchassistanceThe IKS personalized searchfunctionality shall be a semanticservice.The IKS search assistancefunctionality shall be a semanticservice.The IKS natural language searchfunctionality shall be a semanticservice.UC-230606 PM HLR-2306:Personalizedcontent searchassistanceUC-230607 PM HLR-2306:Personalizedcontent searchassistanceUC-230608 PM HLR-2306:Personalizedcontent searchassistance© IKS Consortium2010

196 / 196Deliverable 2.3: Requirements Specification for the Vertical Industrial Use Case© IKS Consortium2010