Difference between revisions of "Resource Management"

Revision as of 16:22, 8 July 2016

This application lets administrator users to manage resources providing the basic functionalities to access and modify their data information. The interface has 5 main sections:

• Resource Navigation
• Resource List
• Profiles
• Related Resources
• Main Menu
• Creating Activation records for Content Manager
• Creating Activation records for View Manager
• Uploading software on the infrastructure

Dimensions of the former 4 panels are customizable by drag-and-dropping their borders. It's also possible to collapse them by clicking their upper right button;

Resource Navigation

This section allows browsing of resources, accessing main resources categories and sub categories. Sub categories are retrieved dynamically using these resource properties:

Resources

|----Collection
|     |----User / System
|
|----gCube Hosting Node
|     |----Site
|
|----Generic Resource
|     |----Secondary Type
| 
|----Metadata Collection
|     |----Schema Name
|
|----Software
|     |----Service Class
|
|----Running Instance
      |----Service Class

WSResources

|----Service Class
      |----Service Name

A click on a resource category forces the portlet to show the list of available resources of that category for the current scope in the Resource List panel.

Resource List

This section provides a list of all accessible resources of the selected category/subcategory (see Resource Navigation) in the current scope. Displayed columns are different for every category. It is also possible to hide/show columns by enabling/disabling them from the menu available in the column headers. Ordering options are available for every column in the same menu.

Right-clicking on selected resource(s) users can access to a contextual menu which provides different operations depending on the selected category. Available operations are :

1. Retrieve Profile  : shows the selected resource(s) profile(s) in the Profiles panel;

1. Find Related Resources : shows the selected resource(s) related information in the Related Resource panel;

1. Add To Scope  : shows the form which lets users to add selected resource(s) to an accessible scope;

   The form shows the selected resources and a list of available destination scope(s)(if any).

   The operation is performed by pressing the "Add to selected scope" button.

   

1. Remove From Scope  : removes the selected resource(s) from the current scope;

   This operation removes the selected resource(s) from the selected scope(s) by modifying his profile. If a resource isn't published in any other scope, this operations causes the complete deletion of that resource from the Information System. Please note that it's not possible to remove a resource from an Infrastructure level scope.

1. Edit  : shows the form which lets users to edit details of a specified resource;

   The shown form depends on the selected resource's category. A check is performed during the insertion of specified fields to prevent an incorrect editing. In the example below the field "body" of a Generic Resource doesn't contain a correct XML text, so the form higlights it specifing that the constrain is not satisfied.

   

1. New  : shows the form which lets users to create a new resource of the selected category;

   The shown form depends on the selected resource's category. A check is performed during the insertion of specified fields to prevent an incorrect editing. In the example below is shown the form to register a new Software and empty mandatory fields are highlightened.The software archive of Software to be registered can be specified either by inserting a local path in the user's computer or by inserting its url.

   

1. Delete  : deletes the selected resource(s) from the Information System;

   This operation causes the deletion of the selected resource(s) from the current scope and recursively from all of it's underlying scopes. If the resource(s) are published in other scopes of an upper or same level of the current scope this operation is implemented as a set of calls to Remove From Scope operation to prevent the cancellation from those scopes.

1. Ban  : shows the form which lets users to create custom filters to ban resources;

   The form is divided in 3 main sections:

   The "Select filter level" part shows the selected resource's profile structure to let people specify which tag(s) must be evaluated by the filter.

   The center part lets users define the kind of condition to be evaluated by the filter. A newer condition is defined by pressing the "Add filter" button. The "Remove filter" button allows user to delete the selected filter from "Filter summary" grid.

   The "Filter summary" part shows the condition(s) already defined by the user, which will form the ban filter.

   The filter is actually submitted to the system in the current scope after pressing the "Submit Filter" button.

   

1. Shut Down  : shows the form which lets users to shut down the specified gCube Hosting Node(s);

   The form shows the selected gHN to shut down, and lets user to specify the options "reset" and "clean state" for the operation.

   

1. Deploy  : shows the form which lets users to deploy specified Software(s) to one or more gCube Hosting Nodes;

Profiles

This Panel shows a set of profiles as requested by the user. Each Profile panel shows the name of the related resource as header, and allows users to brows within the related profile structure by showing it as a tree. In the bottom of the panel there are 3 buttons:

1. Close : closes the current profile.
2. Close All : closes every profile;
3. View as XML : opens a popup containing an XML formatted text view of the current profile.

Related Resources

This panel shows related information about one or more specified resources. Depending on the category of the resource, the kind of information displayed is different :

• Collection  : list of information about related Metadata Collections;
• gCube Hosting Node  : list of information about all Running Instances running in the specified node;
• Generic Resource  : not available;
• Metadata Collection  : list of information about related indexes;
• Software  : list of information about deployed instances of the specified Software;
• Running Instance  : information about the selected Running Instance's gCube Hosting Node and Software;
• WSResource  : same information of Running Instance, based upon the one which published the selected WSResource;

Each related resources tab panel displays as its header the name of the selected resource on which the "Find related resources" operation has been performed, and its icon. Users can close each tab either by pressing the "X" icon on it, or selecting the "Close Tab" option from the context menu on the header of the tab itself. From the same context menu users can choose the option "Close All Tabs" to close every tab in this section.

Main Menu

Main Menu provides a set of menus to perform the operations below:

1. Find  : shows a profile by providing its resource's unique ID;
2. Refresh  : forces refresh of a part/ all the portlet interface information;
3. Create  : shows a form to create a specific kind of resource;

The scope combobox is available only in stand alone mode, and lets users to change the current scope for general monitoring purpose. Please note that changing a scope forces a complete refresh of all displayed information in the portlet.

The "Current scope" text field displays the current scope in which the portlet is operating, and the "Resources List" field displays informations about the status of Resources List part.

Configuration

The portlet is intended to operate in 2 different modes:

• In portal mode

In this state the portlet offers the entire set of possible operations on resources but it allow access to only the scope related to user's portal session.

• Stand alone mode

In this state the portlet offers the possibility to access all available scopes, but it's not possible to make any changes to resources.

The configuration is done by editing the config file config/config.properties and setting the values "true|false" to the mode labels. Please note that this file is loaded by the application at start-up time, so you need to restart it after editing the file, to let the modifications affect the portlet's behaviour.

Scopes

To let the portlet manage new INFRASTRUCTURES and VO scopes , you should edit the xml/scopedata.xml file by putting new scopes description as described in the Configuring Infrastructure Viewer section of the Monitor System documentation.

Creating Activation records for Content Manager

Entitled users can create Activation records by going to Tools > Create > Activation records for Content Manager menu option as shown in the figure below.

An Activation Record is an entity that allows the automatic creation of either GCUBECollections or GCUBEViews

Once the option is selected, the following form appears and has to be filled:

This window is divided in two sections, the first one require the user to provide basic parameters, the other one require to provide the plugin parameters.

• 'Basic parameters fields':
  • Resource Id: Pre-filled by the system, no user action is required
  • Resource Name: Pre-filled by the system, no user action is required
  • Secondary Type: The two possible values are:
    • Activation Record: select this option to create the collection.
    • Virtual Collection: no documentation is provided.
  • Description: the user has to provide a description for this collection

• 'Plugin parameters fields':

The data input to provide in this case vary depending on the type of plugin selected. If you choose to use OAI-PMH as transfer protocol there are 2 possible options depending on your needs:

• • oaiCreateParametersBySets: to create a collection for each set of the external repository.
    • In this case the mandatory information you have to provide are the following:
      • base URL (e.g. http://aquacomm.fcla.edu/cgi/oai2)
      • contentXPath (e.g. //*[local-name()='identifier' and contains(.,'://')])
      • default metadata format (e.g. oai_dc)
    • There are also other non mandatory information we suggest to provide:
      • prefix: a random string that identifies the ecternal repository
      • title Xpath: the XPATH from which we can retrieve the title of a document (e.g. //*[local-name()='title'])
      • alternatives Xpath: xpath to define possible alternatives (e.g. //*[local-name()='relation' and contains(.,'://')])
      • repository name: self explaining field (e.g. aquacomm)
      • setIdentifierList: the id of the set to take into consideration

• • oaiCreateParametersRepository: it has to be used to create a collection containing the entire data available in the external repository.
    • In this case the mandatory information you have to provide are the following:
      • base URL (e.g. http://aquacomm.fcla.edu/cgi/oai2)
      • contentXPath (e.g. //*[local-name()='identifier' and contains(.,'://')])
      • default metadata format (e.g. oai_dc)
    • There are also other non mandatory information we suggest to provide:
      • prefix: a random string that identifies the ecternal repository
      • title Xpath: the XPATH from which we can retrieve the title of a document (e.g. //*[local-name()='title'])
      • alternatives Xpath: xpath to define possible alternatives (e.g. //*[local-name()='relation' and contains(.,'://')])
      • repository name: self explaining field (e.g. aquacomm)
      • collection description: a description for a collection
    • In this case we suggest not to define the field:
      • setIdentifierList: the id of the set to take into consideration

Creating Activation records for View Manager

Entitled users can create Activation records by going to Tools > Create > Activation records for View Manager menu option as shown in the figure below.

The purpose of this tool is the one of automatically creating a View (Metadata or Annotations) over a Collection.

Once the tool is selected the following form has to be filled:

The user should:

• Add a description for the View
• Select whether Metadata or Annotation type
• Select the Collection to apply the View on
• In the following fields (Properties) a user should enter the properties he wants to be verified by the returned objects when visualizing a View, the mandatory fields are the following:
  • name : a generic name for the View
  • schema name: the schema name for the chosen metadata
  • language: the metadata language ((e.g. unknown in case of OAI repositories)
  • schemaURI: the metadata schema (e.g. http://www.openarchives.org/OAI/2.0/oai_dc.xsd)
  • isEditable: self-explaining field ( (e.g. true or false)
  • isIndexable: self-explaining field ( (e.g. true or false)
  • isUserCollection: specifies whether the collection is User or System (should always been set to true)