Table of Contents
List of Tables
Table of Contents
Before performing any administrative tasks on a database node, you have to be authenticated with administrative permissions. The application ships with a default
administrative account, admin. The default password for this account is default.
Important
Make sure you change the default password immediately after setting up the node.
To log in to the application, click on "Login" on the lower left hand side of the page. The login dialog appears:
Login dialog
Enter valid credentials and confirm by clicking "Login".
Upon successful login, the administrative menu bar will appear in the top section of the page.
Once logged in, click on "My Profile" in the lower left hand corner of the page. Then enter the new password in the "Password" and "Repeat Password" fields.
Confirm by selecting the button "Change user information".
A confirmation message will be shown indicating that the password has been changed.
Table of Contents
For managing access to the various features of the application as well via the web user interface as well as the application service interface, a role-based approach has been implemented.
By default, an anonymous user (one that is not authenticated) can browse, search and read all datasets that are public. For all other operations, special permissions are necessary. The following table lists all available permissions (roles):
Table 2.1. Access rights (roles)
| Role | Description |
|---|---|
| Metadata read | This role grants permission to read the metadata of process datasets. |
| Full read and export | This role grants permission to read/display all sections of a process dataset as well as export (download) it as XML. |
| Checkout for editing | This role grants permission to check out a dataset for editing. The dataset will be locked for edit operations until checked in again. |
| Checkin of data sets | This role grants permission to check in a dataset after editing. |
| Release management | This role grants permission to modify the released/unreleased status of a dataset. |
| Delete data sets | This role grants permission to delete datasets from the database. |
| Manage user | This role grants permission to add, edit and remove users and groups. |
| Admin rights | This role grants permission to access the administrative functions via the web interface. |
These roles can be assigned to groups. For instance, an imaginary group TOOLS may be assigned the roles Checkout for editing and Checkin of data sets. Furthermore, a user can be assigned to a group. For example, the user "tool1" could be assigned to the group TOOLS, hence this user account may connect to the database and perform dataset checkin and checkout operations.
The "User" menu offers the options to add and manage users or groups.
To add a user, select "Add user" from the User menu. The "Create User" page will appear.
Fields marked with an asterisk (*) are required. When finished with entering the data, select the button "Create user":
To edit a user profile, select "Manage users" from the "User" menu. A page with the list of all users will appear. You can edit a user profile by clicking its name, or delete users by selecting one or multiple entries using the checkbox in the left column and then selecting the "Delete" button.
To add a group, select "Add group" from the User menu. The "Create Group" page will appear. You can select the roles that you want to be associated with this group, as well as the users you want to belong to this group. This can be changed at a later time as well.
To edit a group, select "Manage groups" from the "User" menu. A page with the list of all groups will appear, with the list of roles associated with each group showing in the "Roles associated" column. You can edit a group by clicking its name, or delete groups by selecting one or multiple entries using the checkbox in the left column and then selecting the "Delete" button.
Table of Contents
To import datasets into your soda4LCA node, select "Import" from the "Data Import/Export" menu:
Then select "Browse":
Now an operating system file dialog will appear, allowing you to select the desired file(s):
You may select one or several of the following file types:
XML documents containing ILCD datasets
ILCD ZIP archives containing ILCD datasets
When you are finished selecting files and confirm the file system dialog, a list of selected files will appear on the page. Click "Upload" to upload them to the server.
Once the upload is finished, a corresponding message will appear:
Now select the "Continue to step 2" button. A list of all uploaded files will appear.
Select "Import files". As the import progresses, messages will be written to the status log console.
Important
During the import, do not reload the page.
When the message "Import of files finished" appears, the import is complete.
Review the status log for error messages. When a dataset of the same UUID and version already exists in the database, this dataset will not be imported and a message is written to the status log.
The entire database can be exported to a ZIP file that can be stored locally on the client. That file can later be imported to an empty database.
To export the database, select "Export Database" from the "Data Import/Export" Menu.
Then click the link "Export entire database to ZIP file".
Your browser will prompt you with a download dialog and download the ZIP file.
Each dataset carries a unique UUID (Universally Unique Identifier) as well as a version number that is to be incremented when the dataset is updated.
In general, always only the latest version of a dataset (i.e. the dataset with the highest version number) is shown. Previous versions can be accessed by navigating to the most recent version and then selecting the desired version from the "Other versions" section on the dataset overview page:
To delete one or more datasets, select the appropriate entry from the "Manage Datasets" menu:
Then navigate to the dataset(s) that you intend to delete. Each dataset version will be displayed as a separate entry.
For every dataset to be deleted on a page, select the checkbox in the first column. Then select the "Delete" button:
A confirmation dialog will appear.
Upon confirmation, the datasets will be deleted from the database and for each deleted dataset, and information message is shown.
Table of Contents
To review the information exposed by the local node to other nodes on the network, select "About this node" from the "Network" menu:
The node and administrator information is shown. Refer to the Installation Guide for information on how to edit this information.
To add a node to the list of foreign nodes known to the local node, select "Add Node" from the "Network" menu. On the following page, you can enter the following:
a service URL (required)
a username/password combination (optional).
Enter the service URL of the node you want to add and select the "Add node" button:
The application will attempt to connect to the foreign node and retrieve its metadata. If this was successful, the node is added to the list of foreign nodes, and a confirmation message will appear:
If the connection fails (due to the foreign node being unreachable, the entering service URL being incorrect etc.), the list of nodes will not be altered and the "Add node" page will still be shown.
Table of Contents
Note: The functionality described in this chapter is not yet available in the 1.2.0 release.
In order to utilize the advanced network capabilities of the application, the node needs to be registered with an existing registry. Before the registration process can start, the registry has to be added to the application's list of known registries. Only users with administrator privileges are allowed to perform this operation. In order to add a new registry:
Navigate to Network -> Registries
Press the "Add registry" button:
The following form will be displayed:
Fill in all mandatory fields and press "Save"
All values that have to be inserted will be published. It is important to insert the exact values, especially UUID and Base URL. In case the network doesn’t work as expected, please check the value of UUID.
Users with appropriate privileges have to possibility to inspect the details of a registry.
Select "Registries" from the "Network" menu
Click on the appropriate registry name and consult the registry details.
When a node is the part of the network, registry details and a list of nodes in the network will be displayed. Otherwise, only the registry details will be shown.
Users with appropriate privileges have to possibility to edit details of a registry.
Navigate to "Network" -> "Registries"
Click "Edit registry" in the "Action" column of the selected registry
You will be redirected to the "Registry details" page.
Insert new values and press "Save".
Users with appropriate privileges have the possibility to remove a registry from the list of registries known to the node. Registries on which the node is already registered cannot be removed, the node has to be deregistered first.
Navigate to Network -> Registries
Click the "Edit registry" link in the "Action" column of the selected registry.
The system will ask for confirmation.
Confirm the choice.
A confirmation message will be displayed.
To send a node registration request to a registry, execute the following steps:
Navigate to Network -> Registries
Select "Registry" and in the "Action" column click on "Register" – the registration page will appear.
Complete the "Access Account" and "Access Password" fields. Note: these fields are not your credentials for the node application! These fields will be used to authenticate the deregistration action, so keep this information for later. Node ID and Base URL are entered by default by the system, but it is possible to change the values. Please be careful with the URL – in case of an incorrect value, the registration will be not processed.
After successfully sending the node registration request, the status of this node on the registry is "Pending registration".
When the registry administrator approves your request, the status will be changed to "Registered". You will be also informed about the approval by email.
Note: A node can be registered in multiple networks.
In order to deregister a node from a registry, follow these steps:
Navigate to Network -> Registries
Find the registry you want to deregister from and click the "Deregister" link in the "Action" column
You will be redirected to the authorization page. Enter user and password which were selected during registration and click Deregister
After pressing the button, you will be asked for confirmation. Click "Yes":
The system will prevent you from deregistration if there are any registered datasets. You will be asked to deregister the datasets first.
If the user name and/or password entered are incorrect, an appropriate message will be displayed.
