Difference between revisions of "FieldsManagement"
(→Edit an existing Field) |
|||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
The Fields Management portlet provides the functionality to create, edit and/or delete the available Search Fields.<br> | The Fields Management portlet provides the functionality to create, edit and/or delete the available Search Fields.<br> | ||
A Field is the main object in the Search process. It is used and shared between the services and the libraries that take part in the search process. | A Field is the main object in the Search process. It is used and shared between the services and the libraries that take part in the search process. | ||
| + | <br> | ||
| + | This portlet works supplementary to the automatic procedure of the [https://gcube.wiki.gcube-system.org/gcube/index.php/Resource_Registry Resource Registry] that fills in the fields' information transparently. | ||
| + | Using this portlet you can view the available fields and their information and you can edit/delete any of them. When a field is edited or deleted from the portlet the Resource Registry won't override this change. | ||
A field must/can have: | A field must/can have: | ||
| Line 14: | Line 17: | ||
* The Source Locator: The index id of the corresponding collection (Must) | * The Source Locator: The index id of the corresponding collection (Must) | ||
* The index capabilities : What does the corresponding index supports | * The index capabilities : What does the corresponding index supports | ||
| − | * The index Query Expression: How | + | * The index Query Expression: How can we access the corresponding index (i.e The xpath expression for an XML index) |
<br> | <br> | ||
| Line 21: | Line 24: | ||
* Collection ID: The id of the collection (Must) | * Collection ID: The id of the collection (Must) | ||
* The Source Locator: The index id of the corresponding collection (Must) | * The Source Locator: The index id of the corresponding collection (Must) | ||
| − | * The index Query Expression: How | + | * The index Query Expression: How can we access the corresponding index (i.e The xpath expression for an XML index) |
* Presentation Information: Extra information on how this field will be displayed to the end user | * Presentation Information: Extra information on how this field will be displayed to the end user | ||
<br> | <br> | ||
| − | The portlet is divided into | + | The portlet is divided into 3 tabs. |
| + | * The Fields Management tab | ||
| + | * The Collections' fields tab | ||
| + | * The Annotate fields tab | ||
| + | <br> | ||
| + | |||
| + | The first tab consists of two panels. The left panel displays the list with the available fields and the right panel displays the properties of the selected field or the form to be completed when a new field is created.<br> | ||
[[Image:FmMain.png]] | [[Image:FmMain.png]] | ||
<br> | <br> | ||
| − | In the left panel there is a toolbar. The first button | + | In the left panel there is a toolbar. |
| + | * The first button creates a new field | ||
| + | * The second button refreshes the information for the available fields | ||
| + | * The third button resets the fields' registry and retrieves the dynamic information again | ||
| + | |||
On each field there is a '''delete''' button. By clicking on this button you can delete the corresponding field.<br> | On each field there is a '''delete''' button. By clicking on this button you can delete the corresponding field.<br> | ||
==== Edit an existing Field ==== | ==== Edit an existing Field ==== | ||
| − | When you select a field from the tree its properties are displayed to the right panel. There you can edit the field's properties, you can create/edit/delete the searchables and presentables and finally | + | When you select a field from the tree its properties are displayed to the right panel. There you can edit the field's properties, you can create/edit/delete the searchables and presentables and finally you can persist the performed changes.<br> |
[[Image: FmNoSearchablePresentable.png]] | [[Image: FmNoSearchablePresentable.png]] | ||
<br> | <br> | ||
| Line 44: | Line 57: | ||
[[Image:FmSearchablePanel.png]] [[Image:FmPresentablePanel.png]] | [[Image:FmSearchablePanel.png]] [[Image:FmPresentablePanel.png]] | ||
<br><br> | <br><br> | ||
| + | |||
| + | When you create a Searchable for a field, that already has a name, the portlet suggests the allowed values for the '''Collection ID''' property. The allowed values depend on the current status of the system. | ||
| + | Then depending on the collection ID, it suggests the allowed values for the '''index ID''' and it automatically fills in the '''Index capabilities''' when the text box is focused.<br> | ||
| + | The Collection ID and the Index ID are also suggested for any new Presentable. | ||
When you create a new searchable/presentable the mandatory fields must be completed, otherwise an error message is displayed and the changes are not applied to the field.<br> | When you create a new searchable/presentable the mandatory fields must be completed, otherwise an error message is displayed and the changes are not applied to the field.<br> | ||
| Line 50: | Line 67: | ||
==== Create a new Field ==== | ==== Create a new Field ==== | ||
| + | Click on the second button of the toolbar in order to create a new field. After confirming that you really want to create a new field the right panel displays the form for the new field<br> | ||
| + | [[Image:FmNewField.png]] | ||
| + | <br> | ||
| + | |||
| + | The property: Name is the only mandatory for a new field, but you can also add a descritpion and as many searchables and presentables you want. when you finish click on the ''''Save'''' button to create the field.<br> | ||
| + | If the field is created successfully then it is displayed at the field's list tree. | ||
| + | <br> | ||
| + | |||
| + | ==== Collections' fields Tab ==== | ||
| + | |||
| + | In this tab a tree with the available collections and the related searchable and presentable fields is visualized. | ||
| + | Using this tree you can easily inspect the available fields for each collection. <br> | ||
| + | [[Image:Fmp-colDields.png]] | ||
| + | |||
| + | ==== Annotate fields Tab ==== | ||
| + | |||
| + | In this tab you see a list with all the available fields. For each field you can see the available annotation and you can add or remove any of them. | ||
| + | These annotations will be exploited by the semantic enrichment component. | ||
| + | [[Image:Searchmanager-annotations.png]] | ||
Latest revision as of 13:13, 11 April 2014
The Fields Management portlet provides the functionality to create, edit and/or delete the available Search Fields.
A Field is the main object in the Search process. It is used and shared between the services and the libraries that take part in the search process.
This portlet works supplementary to the automatic procedure of the Resource Registry that fills in the fields' information transparently.
Using this portlet you can view the available fields and their information and you can edit/delete any of them. When a field is edited or deleted from the portlet the Resource Registry won't override this change.
A field must/can have:
- A Name (Must)
- A Description
- A list of searchables
- A list of presentables
Each searchable that is part of a field represents the way we can search for this field inside the given collection ID. The needed information is:
- Collection ID: The id of the collection (Must)
- The Source Locator: The index id of the corresponding collection (Must)
- The index capabilities : What does the corresponding index supports
- The index Query Expression: How can we access the corresponding index (i.e The xpath expression for an XML index)
Each presentable that is part of a field states that this field for the given collection ID can be displayed as part of a search result. The needed information is:
- Collection ID: The id of the collection (Must)
- The Source Locator: The index id of the corresponding collection (Must)
- The index Query Expression: How can we access the corresponding index (i.e The xpath expression for an XML index)
- Presentation Information: Extra information on how this field will be displayed to the end user
The portlet is divided into 3 tabs.
- The Fields Management tab
- The Collections' fields tab
- The Annotate fields tab
The first tab consists of two panels. The left panel displays the list with the available fields and the right panel displays the properties of the selected field or the form to be completed when a new field is created.
In the left panel there is a toolbar.
- The first button creates a new field
- The second button refreshes the information for the available fields
- The third button resets the fields' registry and retrieves the dynamic information again
On each field there is a delete button. By clicking on this button you can delete the corresponding field.
Contents
Edit an existing Field
When you select a field from the tree its properties are displayed to the right panel. There you can edit the field's properties, you can create/edit/delete the searchables and presentables and finally you can persist the performed changes.
The changes you are making are temporary saved. When you perform a change, a warning message is displayed to inform you that you have to click on the 'Save' button to persist your changes.
A field may contain many searchables and presentables fields.
When you create a Searchable for a field, that already has a name, the portlet suggests the allowed values for the Collection ID property. The allowed values depend on the current status of the system.
Then depending on the collection ID, it suggests the allowed values for the index ID and it automatically fills in the Index capabilities when the text box is focused.
The Collection ID and the Index ID are also suggested for any new Presentable.
When you create a new searchable/presentable the mandatory fields must be completed, otherwise an error message is displayed and the changes are not applied to the field.
Create a new Field
Click on the second button of the toolbar in order to create a new field. After confirming that you really want to create a new field the right panel displays the form for the new field
The property: Name is the only mandatory for a new field, but you can also add a descritpion and as many searchables and presentables you want. when you finish click on the 'Save' button to create the field.
If the field is created successfully then it is displayed at the field's list tree.
Collections' fields Tab
In this tab a tree with the available collections and the related searchable and presentable fields is visualized.
Using this tree you can easily inspect the available fields for each collection.
Annotate fields Tab
In this tab you see a list with all the available fields. For each field you can see the available annotation and you can add or remove any of them.
These annotations will be exploited by the semantic enrichment component.
