Producers (see RISCOSS Platform) need to create the Entities to be analysed. These Entities can be organised in Layers. A Layer defines a logical group of entities, their structure, and a parent-child relationship with another layer. This parent-child relationship is implicitly defined for all the entities belonging to a layer and allows the user to create a hierarchy of entities. In addition to the hierarchy of entities, layers also defines the attributes associated to the entities belonging to it.

images/entities_tree.png

In this example, there are 4 layers and 20 entities in our knowledge base.

The assets management is centralised in the Layers and Entities pages inside the Configure menu

images/UI_webapp/configure_layers_entities.png

Step 1: Creating Layers

RISCOSS can run risk assessment at different levels. Therefore, the first step is specifying your own organization structure, defining the different organisational units (layers) of analysis to be put under RISCOSS’ supervision. RISCOSS uses as essential organizational unit the OSS Component, in the sense of the Product produced by an OSS Project to be adopted in any of the company's organizational units.

Layers can be created from the Layers management page by entering the new layer's name and the layer's parent in the form that appears.

images/UI_webapp/new_layer.png

After clicking the New layer button, you can add/modify some details about the layer:

• The layer name (Name field)
• The parent-child relation to other existing layers (Parent field).
• A description of the layer (Description field)
• The layer information that describes the entities belonging to this layer (Layer information panel)

images/UI_webapp/edit_layer.png

The layer is stored in the platform using the Save button below the description field. The layer can be deleted - if there are no restrictions such as the existence of associated entities - using the Delete button next to it.

#Step 2: Creating Entities There are 3 options to create entities. The first 2 options are meant to create entities manually and the last one to import them from a file.

Stet 2.1: Start creating an Entity from the Layer Management

Choosing Layers from the Configure menu. The platform will show the list of all layers defined in the domain. Choosing a layer from the list will show the list of all entities defined in the domain associated to the selected layer.

images/UI_webapp/layer_list.png

Enter the new entity name in the Name form field and click on the New entity button next to it to create the new entity.

Step 2.2: Creating the new Entity from the Entity Management

Enter the entity’s name in the form that appears and select the entity's layer from the list.

images/UI_webapp/new_entity.png

After clicking the New entity button, you can add/edit some details about the entity:

• The entity's layer (Layer field)
• The entity's description (Description field)
• Layer information values and parent/children relationships between entities (Properties tab panel)
• The entity's custom information (Custom information tab panel)
• Configuration of entity's data collectors (Data collectors tab panel)
• The entity's collected data (Data repository tab panel)
• A list of existing Risk Analysis Session in the domain associated to the entity (Analysis Sessions tab panel)

images/UI_webapp/entity_info.png

The entity is stored in the platform using Save button below the Description field

Step 2.3: Importing Entities

A set of defined entities and its information can be imported using an XLSX file. This file collects the following information:

• Entities to be created
• Relationships between entities
• Custom information about the entities

An example of this XLSX file would look like the following:

images/import_file.png

Each row of this file defines a relationship between a parent entity and its children. Different columns are used to set custom information of each entity, according to the configuration file (see below). Note: The first entity should be placed in row number 7 (being the first row number 1).

Clicking in the Import entities option inside the Configure menu will display a file navigator, from where the user will select the XLSX to be imported.

images/UI_webapp/import_entities_menu.png

Once the importation has finished, the application will be redirected to the Entities management page.

Note: The imported file can be customised using an XML file. Details about the configuration of the imported file in How to configure entities import file

Step 3: Configuring Data Collectors for Entities

In the Entity Management page (when the entity is created or edited), there is a tab panel Data collectors with a list of available data collectors. The available data collectors are those that have been configured in the system by a system administrator, and the parameters the user has to fill depend on the nature of the data collector.

The data collector is selected using the tick of the data collector, and depending on the data collector some configuration data is needed.

images/UI_webapp/data-collectors.png

For example, the user is associating a Jira data collector that is able to retrieve bug tracking data from a JIRA system, and he has to provide the URI where this system is installed and the credentials for accessing to it. Once the entity is saved, the Data Collector Manager will start to schedule the data collectors associated to the different entities, and run them for populating the Risk Data Repository with risk data that can be then used when the actual risk analysis will be performed.

#Step 4: Exploring Layers and Entities Layers and Entities can also be browsed by choosing the corresponding menu items in the Configure menu - Layers and Entities.

images/UI_webapp/layers.png

images/UI_webapp/entities.png