Cloud platforms Lead to Open and Universal access for people with Disabilities and for All. Semantic Alignment Tool (SAT) - Manual

Transcription

1 Cloud platforms Lead to Open and Universal access Semantic Alignment Tool (SAT) - Manual 1

2 Table of Contents 1 Introduction Functionalities User User registration Request Vendor Role View solutions View the registry of common terms Vendor User registration View/Edit Profile Add a new solution View/Edit solution View the registry of common terms Administrator User registration Add a new solution View/Edit solution Manage the registry of common terms Manage Proposals List of Tables Table 1 Roles and functionalities

3 List of Figures Figure 1 User registration... 6 Figure 2 Browse solutions according to ISO9999 categorization... 7 Figure 3 Search by application name... 8 Figure 4 Search by application type... 8 Figure 5 View solution... 9 Figure 6 View the registry of common terms Figure 7 Export registry terms Figure 8 JSON automatically generated by the SAT tool describing the registry terms Figure 9 Edit profile Figure 10 Select category from ISO 9999 standard Figure 11 Search category Figure 12 Propose a new application category Figure 13 Add solution s metadata Figure 14 Load Eastin properties Figure 15 Specify technical details based on Eastin taxonomy Figure 16 Propose a new item for the group Figure 17 Propose a new group of items dialog Figure 18 Add application access info dialog Figure 19 Create a new entry or select an existing Figure 20 Add application specific setting Figure 21 Application specific settings Figure 22 Align setting against registry of common terms Figure 23 Edit application settings Figure 24 Add new setting Figure 25 Add new registry term dialog Figure 26 Edit a registry term dialog

4 Figure 27 Manage proposals panel Figure 28 Edit proposed taxonomy group Figure 29 Edit proposed taxonomy item Figure 30 Edit proposed application type

5 1 Introduction Semantic Alignment Tool is a common interface for all interested vendors, providers, administrators, etc. that intend to include their solutions and their solutions-unique settings in the Cloud4all/GPII architecture, as well as for developers /designers and interested end users that intend to have access on the Cloud4all/GPII solutions-unique settings of the offered solutions and services. More specifically, the tool can support users for performing syntactic and semantic analysis of their solutions' settings as well as a semi-automatic categorization of solutions/settings that are stored in the Cloud4all semantic framework of content and solutions ontology. Thus, the tool can assist users/vendors/service providers to help visualising annotated content presented in the ontology as well as for improving existing annotation structures and instances. The scope of this document is to describe the functionalities the system performs according to the privileges that a role has. There are three kinds of roles: user role, vendor role and administrator role. In the following table, the roles are presented together with the functionalities that the system performs for them. Roles Operations User Vendor Administrator View solutions View the registry of common terms Request vendor role Add new solution Edit/view solution View the registry common terms View/Edit my profile Add new solution Edit/view solutions Manage the registry of common terms, Manage proposals Table 1 Roles and functionalities In the following sections, functionalities are described in detail according to the privileges. 2 Functionalities 5

6 2.1 User User registration User registration is a common step for every user in order to enter the system. Users can enter the system using their credentials, as only authenticated users may register a new solution or solution-unique setting and/or remove assets from it. At the same time the SAT is being connected automatically with the latest ontology from the Cloud4all SEMA ontological framework in order to access the latest stored data. After successful login, each user can choose one of the functionalities performed by the tool according to his role (Figure 1) Request Vendor Role Figure 1 User registration A user can request the vendor role to get the privileges of a vendor by pressing the corresponding button ( Request vendor role button). When, a user requests vendor role, an is sent to the administrator of the system informing him about user s request and user s personal information (full name, address). Once the administrator gets the request, he can advance the user to vendor. 6

7 2.1.3 View solutions Select solution The tool prompts the user to select a solution for editing/viewing. For the assistance of the users in order to select the solution, two different choices are being provided. The first one is browsing in a tree-list categorization based on the ISO 9999 standard, by selecting a tree node. If the selected tree node contains solutions, the system will show them in order to help the user select the solution that he prefers (Figure 2). Figure 2 Browse solutions according to ISO9999 categorization The second way is a relevant Search Tab where the user can provide any preferable free-text in order to search a solution by name or by a specific category type. In case the user provides a solution name, by pressing the Search button, the system will show existing solutions names which are related to the preferred name according to an automatic lexicographic analysis (Figure 3). 7

8 Figure 3 Search by application name In case the user provides a category name, by pressing the Search button, the system will show solutions that belong to categories with name related to the typed category name according to the automatic lexicographic analysis, that the system performs (Figure 4). Once the user selects the solution, he can proceed to the next step ( Next button) of viewing or editing. Figure 4 Search by application type 8

9 View solution This step differs according to the role that someone has. A user can view the selected solution but he is not allowed to edit it (Figure 5). He can view application access information for users View the registry of common terms View terms Figure 5 View solution By pressing View the registry of common terms button, the system shows two panels that contain the registry of common terms. The first panel contains accepted terms (derived from Unified Listing or proposed terms from vendors/administrators that were accepted) and the second one contains proposed terms (terms proposed from vendors/administrators that have not been accepted/deleted yet). Every term is described using metadata such as its name, description, value, type, aliases etc. It is worth mentioning, users cannot introduce a new term or edit an existing one (Figure 6). 9

10 Export registry terms Figure 6 View the registry of common terms Users can export (Figure 7) the registry into a JSON format (Figure 8) in order to be used by other Cloud4all/GPII components by pressing the corresponding button ( Export registry terms button). The JSON format contains information related to the name, type, status (accepted, proposed) etc. of each term. Figure 7 Export registry terms 10

11 Vendor User registration See section in User View/Edit Profile Figure 8 JSON automatically generated by the SAT tool describing the registry terms Edit/View my profile is an operation performed for vendors. A vendor can view and edit his personal information except for his name and address (Figure 9). If he makes any changes, he can save them by pressing the corresponding button ( apply changes button). He can also view his reputation by pressing the corresponding button ( view reputation button) and view statistics and other information for his already registered solutions, the service level agreements as vendor, the service level agreements as owner and the end user level agreements. 11

12 Figure 9 Edit profile Add a new solution Introducing a solution contains four steps that complete the whole procedure. These steps are: 1. Select solution type (selection/proposal of the solution category), 2. Add solution s general characteristics and EASTIN properties (general description of the solution, completion/proposals of properties based on EASTIN taxonomy), 3. Add solution s specific settings (adding settings to the solution s specific settings), 4. Solution s specific settings alignment (alignment of solution s specific settings with the registry of common terms) Select Solution Type Step 1 In the first step, the tool prompts the user to select the type of the new solution. For the assistance of the users in order to select the most relevant category of their solution, three different choices are provided. The first one is a tree-list categorization based on the ISO 9999 standard in order to select the most relevant type (Figure 10). By pressing a tree node, the user can select a category (press in the middle of the button) or view subcategories of a category (press + ). 12

13 Figure 10 Select category from ISO 9999 standard The second way is a relevant Search Tab where the user can provide any preferable freetext in order to search a category type (Figure 11). Once the user types the category name and presses the Search button, the system automatically shows a list of existing categories to choose. These categories are related to the typed name through the lexicographic analysis. Figure 11 Search category The last way of selecting category is proposing a new category that is more relevant to the solution that the user is going to introduce (Figure 12). The user can insert name and description for his category and also place the category to the categorization according to the field that is related to by pressing the Select button. He can also select an existing proposed solution category in case that fits most to his application. 13

14 Figure 12 Propose a new application category Once, the user selects the solution category, proceeds to the following step ( Next button) in order to add solution s general characteristics and EASTIN properties Add solution s general characteristics and EASTIN properties Step 2 The tool prompts the user to add general characteristics and EASTIN properties for his application. a. The user can add relevant metadata (name, unified listing id, description, constraints and limitations, insert date, latest update date, manufacturer name, manufacturer country, manufacturer website, thumbnail, original source of information, start and stop command, capabilities, capabilities transformations and setting handler type) that can be used for the characterization of the solutions (Figure 13). 14

15 Figure 13 Add solution s metadata The user can also specify options for the selected handler type providing the name and the value of the option. He can also change the selected category ( Change category button), which was specified in step-1 and use more concrete information for a preferable solution/application/service using a communication with external repositories like the EASTIN database by pressing the Load Eastin Properties button. If the application name is related to solutions that are stored in the external database, the system will show them in a dialog box (Figure 14). The user has the ability to browse through these solutions and import one, in case it fulfills his solution s general characteristics. 15

16 Figure 14 Load Eastin properties b. The user can specify technical details based on Eastin taxonomy. In order to make the most relevant choices, the system provides default items in Eastin taxonomy groups, which are colored blue when user selects them (Figure 15). Figure 15 Specify technical details based on Eastin taxonomy He can also propose new items for every taxonomy group (Figure 16) inserting name, description for it and selecting the type of the item (attribute/measure) or select an existing proposal. Proposed items are colored in orange. 16

17 Figure 16 Propose a new item for the group Users are also allowed to propose a completely new group by pressing the Propose a new group of items button. The proposed group requires name, description and at least an item. When the user finishes with the proposal, submits it by pressing the Submit proposal button (Figure 17). The user can also select an existing proposed group and import it in the current solution. Figure 17 Propose a new group of items dialog c. Users can set application access information for vendors and users, specifying information related to license, commercial cost schema, commercial trial schema etc. (Figure 18). 17

18 Figure 18 Add application access info dialog After completing the second step of describing the solution, user proceeds to the next one by pressing the Next button. In case that one or more existing solutions are similar with the introduced solution, the system shows a message which prompts the user to edit one of the related solutions or create a new entry. In case that user selects a related entry, he can edit it. In case there are no similar entries, the user has to create a new entry (Figure 19) and proceeds to the next step. Figure 19 Create a new entry or select an existing 18

19 Add solution s specific settings Step 3 The third step is an optional step that the user can either skip and proceed to the final step of saving the solution by pressing Save application button or deal with the introduction of the application-unique settings for each of the corresponding solutions. The first action required by the user in order to add a new setting is press the Add application specific setting button, which opens a panel. The user completes relevant metadata (setting name, description, value space, id, constraints/limitations, type, is applied live) that are required for the characterization of the solution s settings (Figure 20). Figure 20 Add application specific setting After completing this information, the setting can be added to the application s specific settings panel(figure 21) by pressing the Add setting button. The user proceeds to the next step by pressing the Next button. 19

20 Figure 21 Application specific settings Solution s specific settings alignment Step 4 In the fourth step, the user can align the inserted solution-unique settings against semantically corresponding concepts in the registry of common terms (Error! Reference source not found.). More specifically, the user presses the Edit button, that shows a dialog, in which there are options for matching the setting with a term, leave comments related to mapping, propose a new term etc. The system proposes automatically an alignment according to the lexicographic analysis. User can either accept the proposal, select another option or make a a proposal of a new term ( Propose new registry term button). After finishing the alignment process, the user proceeds to the saving of the solution. After saving the solution, system redirects to View/Edit the solution. Figure 22 Align setting against registry of common terms 20

21 2.1.8 View/Edit solution Select solution See section in User View/Edit solution A vendor can view every solution with the difference that he can edit his own solutions. The process of editing includes editing the selected solution s existing metadata, settings, Eastin properties (Figure 23). Figure 23 Edit application settings The authorized user can add/remove settings (Figure 24) and propose new Eastin groups and options, too. He can also set application access information for users etc.. After editing the solution, user saves his changes by pressing the corresponding button ( apply changes button). 21

22 2.1.9 View the registry of common terms See section in User. Administrator User registration See section in User Add a new solution See section in Vendor View/Edit solution Figure 24 Add new setting See section in Vendor considering that administrator can edit and delete all registered solutions Manage the registry of common terms Managing the registry of terms is permitted in administrators and contains four individual operations. These operations are: 1. Add a new registry term, 2. Edit/delete registry terms, 22

23 3. Export registry terms, 4. Synchronize registry terms Add new registry term The administrator can introduce a new registry term by pressing the corresponding button ( Add new registry term button). More specifically, he can add metadata (name, description, value space, type, default value, id, alias, notes) which will characterize the term and then add the term in the registry of common terms by pressing the Add button (Figure 25) Edit/Delete registry terms Figure 25 Add new registry term dialog Administrator can edit or update information of registry terms and proposed terms (Figure 26). If the selected term is an accepted term, administrator can save the changes that he has made or delete the term. In case the selected term is a proposed term, he has the ability not only to edit or delete the term but also to accept or reject the term. 23

24 Export registry terms See section in User Synchronize registry terms Figure 26 Edit a registry term dialog The synchronization of registry terms is a functionality that synchronizes automatically the registry of common terms of the Cloud4all SEMA ontological framework with the Unified Listing using communication with an external repository. The expectation of this process is both Cloud4all SEMA ontological framework and Unified Listing having exactly the same terms. For the time being, the mechanism is on process. As a result only registry terms of SAT are synchronized with the registry of Unified Listing, which means that terms of SAT are updated according to the changes/introductions/removals that have been made in Unified Listing registry. When development process is completed, new functionalities will be supported by the system such as adding a new term in the Unified Listing etc Manage Proposals By pressing the Manage proposals button, administrators have the ability to view and edit all proposed taxonomy groups, proposed taxonomy items and proposed application categories (Figure 27). 24

25 Figure 27 Manage proposals panel More specifically, administrator can edit the name, description and items of proposed taxonomy group, add or remove cluster items and then save his changes (Figure 28). He can also approve or reject the cluster according to his view or any other restrictions, informing the proponent about the reasons for his decision in case of rejecting. Figure 28 Edit proposed taxonomy group As for the proposed cluster items, administrator can edit the name, description, Eastin category and type of the item (select if it is an attribute or a measure item) and apply the changes. Similarly, he can approve or reject proposed taxonomy items and inform proponent about the reasons for his decision, in case of rejecting (Figure 29). 25

26 Figure 29 Edit proposed taxonomy item Concerning proposed application types, administrator can edit the name, description and category to which the proposed type belongs and then apply his changes (Figure 30). He can reject or approve the category and inform proponent about the reasons for his decision, in case of rejecting. Figure 30 Edit proposed application type 26