diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image1.png b/dmp-frontend/src/assets/splash/assets/user-guide/image1.png new file mode 100644 index 000000000..87278bae3 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image1.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image10.png b/dmp-frontend/src/assets/splash/assets/user-guide/image10.png new file mode 100644 index 000000000..bf74bc836 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image10.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image11.png b/dmp-frontend/src/assets/splash/assets/user-guide/image11.png new file mode 100644 index 000000000..b9d6aa2f0 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image11.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image12.png b/dmp-frontend/src/assets/splash/assets/user-guide/image12.png new file mode 100644 index 000000000..7dd6e0543 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image12.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image13.png b/dmp-frontend/src/assets/splash/assets/user-guide/image13.png new file mode 100644 index 000000000..9a0ddef6a Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image13.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image14.png b/dmp-frontend/src/assets/splash/assets/user-guide/image14.png new file mode 100644 index 000000000..126e0b3d8 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image14.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image15.png b/dmp-frontend/src/assets/splash/assets/user-guide/image15.png new file mode 100644 index 000000000..32773afd9 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image15.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image16.png b/dmp-frontend/src/assets/splash/assets/user-guide/image16.png new file mode 100644 index 000000000..c7437e68a Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image16.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image17.png b/dmp-frontend/src/assets/splash/assets/user-guide/image17.png new file mode 100644 index 000000000..04e5e0589 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image17.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image18.png b/dmp-frontend/src/assets/splash/assets/user-guide/image18.png new file mode 100644 index 000000000..1aedddfeb Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image18.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image19.png b/dmp-frontend/src/assets/splash/assets/user-guide/image19.png new file mode 100644 index 000000000..cb2f6eeb3 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image19.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image2.png b/dmp-frontend/src/assets/splash/assets/user-guide/image2.png new file mode 100644 index 000000000..674d888c5 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image2.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image20.png b/dmp-frontend/src/assets/splash/assets/user-guide/image20.png new file mode 100644 index 000000000..d2d44fffb Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image20.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image21.png b/dmp-frontend/src/assets/splash/assets/user-guide/image21.png new file mode 100644 index 000000000..9615111a6 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image21.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image22.png b/dmp-frontend/src/assets/splash/assets/user-guide/image22.png new file mode 100644 index 000000000..e154fd0fe Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image22.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image23.png b/dmp-frontend/src/assets/splash/assets/user-guide/image23.png new file mode 100644 index 000000000..51b88bbe3 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image23.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image24.png b/dmp-frontend/src/assets/splash/assets/user-guide/image24.png new file mode 100644 index 000000000..c1190df74 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image24.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image25.png b/dmp-frontend/src/assets/splash/assets/user-guide/image25.png new file mode 100644 index 000000000..b71a4a5b4 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image25.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image26.png b/dmp-frontend/src/assets/splash/assets/user-guide/image26.png new file mode 100644 index 000000000..4d2f14990 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image26.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image27.png b/dmp-frontend/src/assets/splash/assets/user-guide/image27.png new file mode 100644 index 000000000..3bdc9b2a7 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image27.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image28.png b/dmp-frontend/src/assets/splash/assets/user-guide/image28.png new file mode 100644 index 000000000..9ea0cf376 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image28.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image29.png b/dmp-frontend/src/assets/splash/assets/user-guide/image29.png new file mode 100644 index 000000000..ea7b24876 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image29.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image3.png b/dmp-frontend/src/assets/splash/assets/user-guide/image3.png new file mode 100644 index 000000000..645e6873a Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image3.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image30.png b/dmp-frontend/src/assets/splash/assets/user-guide/image30.png new file mode 100644 index 000000000..f60d05952 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image30.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image31.png b/dmp-frontend/src/assets/splash/assets/user-guide/image31.png new file mode 100644 index 000000000..5039aaae5 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image31.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image32.png b/dmp-frontend/src/assets/splash/assets/user-guide/image32.png new file mode 100644 index 000000000..89a68bfcd Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image32.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image33.png b/dmp-frontend/src/assets/splash/assets/user-guide/image33.png new file mode 100644 index 000000000..b7e8c3251 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image33.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image34.png b/dmp-frontend/src/assets/splash/assets/user-guide/image34.png new file mode 100644 index 000000000..3dc2e4671 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image34.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image35.png b/dmp-frontend/src/assets/splash/assets/user-guide/image35.png new file mode 100644 index 000000000..564577933 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image35.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image36.png b/dmp-frontend/src/assets/splash/assets/user-guide/image36.png new file mode 100644 index 000000000..76fd31ae5 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image36.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image37.png b/dmp-frontend/src/assets/splash/assets/user-guide/image37.png new file mode 100644 index 000000000..c93ad0db8 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image37.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image38.png b/dmp-frontend/src/assets/splash/assets/user-guide/image38.png new file mode 100644 index 000000000..422dd1293 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image38.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image39.png b/dmp-frontend/src/assets/splash/assets/user-guide/image39.png new file mode 100644 index 000000000..140d76b9e Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image39.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image4.png b/dmp-frontend/src/assets/splash/assets/user-guide/image4.png new file mode 100644 index 000000000..bd72e55a1 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image4.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image40.png b/dmp-frontend/src/assets/splash/assets/user-guide/image40.png new file mode 100644 index 000000000..6d89ffdc0 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image40.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image41.png b/dmp-frontend/src/assets/splash/assets/user-guide/image41.png new file mode 100644 index 000000000..ad2a6acea Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image41.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image42.png b/dmp-frontend/src/assets/splash/assets/user-guide/image42.png new file mode 100644 index 000000000..095c8b958 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image42.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image43.png b/dmp-frontend/src/assets/splash/assets/user-guide/image43.png new file mode 100644 index 000000000..4b2398baf Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image43.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image5.png b/dmp-frontend/src/assets/splash/assets/user-guide/image5.png new file mode 100644 index 000000000..6f7002644 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image5.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image6.png b/dmp-frontend/src/assets/splash/assets/user-guide/image6.png new file mode 100644 index 000000000..8c1302485 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image6.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image7.png b/dmp-frontend/src/assets/splash/assets/user-guide/image7.png new file mode 100644 index 000000000..9a290a462 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image7.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image8.png b/dmp-frontend/src/assets/splash/assets/user-guide/image8.png new file mode 100644 index 000000000..aa0e49615 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image8.png differ diff --git a/dmp-frontend/src/assets/splash/assets/user-guide/image9.png b/dmp-frontend/src/assets/splash/assets/user-guide/image9.png new file mode 100644 index 000000000..2aeac3031 Binary files /dev/null and b/dmp-frontend/src/assets/splash/assets/user-guide/image9.png differ diff --git a/user-guide/UserGuideDRAFT.html b/user-guide/UserGuideDRAFT.html index 8cd81c39b..37ad28ec0 100644 --- a/user-guide/UserGuideDRAFT.html +++ b/user-guide/UserGuideDRAFT.html @@ -1,1099 +1,2569 @@ - - + + + - - -

1. Entities & Terminology

-

Key entities

-

Data Management Plan (DMP) - is a collection of dataset descriptions, associated with an activity (“project” or “grant”). A DMP may be versioned, is exportable to various forms, currently machine readable (xml, json) and human readable (pdf/openxml) and can be assigned a DOI and published in Zenodo. -

-

 

-

Dataset Description - is the description of a dataset according to a set of rules that is the dataset profile (aka template). -

-

 

-

Dataset Profile - is the set of rules that describe what dataset descriptions contain and how they are handled. Dataset Profiles are modified by Admins and contain attributes/fields, behavioral rules (e.g. toggling visibility of fields) and validation rules. Dataset Profiles are linked to DMPs for focusing users on specific formats of descriptions. -

-

 

-

Project - is a logical entity that defines the context where one or more Data Management Plans may be formed in. -

-

 

-

Grant - is a logical entity that defines the context where one or more Data Management Plans may be formed in. -

-

 

-

Users - are associated to DMPs and other entities for authorization and may map to researchers. -

-

 

-

 

- - - - - - -
-

DMP Wizard - is an easy way to start writing a DMP. Wizard provides an interface that goes through the essential elements of a DMP and guides the process of its creation step by step. -

-

 

-

From “Homepage”

-

-

-

 

-

From “My DMPs”

-

-
-

 

-

 

- - - - - - -
-

DMP Expert - provides additional metadata to the DMP.

-

 

-

From “Homepage”

-

-

 

-

From “My DMPs”

-

-
-

 

-

 

- - - - - - -
-

Dataset Description Wizard - is an easy way to add new dataset descriptions to pre-existing DMPs. -

-

 

-

From “Homepage”

-

-

-
-

 

-

 

- - - - - - -
-

Dataset Description Expert -provides additional metadata to the dataset description.

-

 

-

From “My Dataset Descriptions” -

-

-
-

 

-

Secondary entities

-

Repository - - an electronic database or an information system where data is stored and maintained.

-

Dataset -- a collection of data which are bind together under a specific format. -

-

Registry -- a database of entities and descriptions.

-

Service -- a software of specific operations and tasks that interacts with other software and hardware -

-

Researcher -- an individual practicing research

-

Funder -- an organisation that funds research programmes and/ or researchers’ activities -

-

2. Menu Navigation

-

The main menu is located on the left side of the screen. Depending on how users view the tool, i.e. whether they have logged in or not, the main menu changes to include features that are available only in individuals’ dashboards. -

-

 

-

 

- - - - - - - -
-

Main menu - not logged in

-

 

-

Home - - gets you back to the homepage / dashboard -

-

About - - informs about the scope and main functions of the tool -

-

Published DMPs - - shows the full-text of DMPs that have been made publicly available -

-

Published Dataset Descriptions - - shows the full-text of Dataset Descriptions that have been made publicly available -

-

Glossary -- includes the terminology used in the tool and explains basic components -

-

Terms of Service - - provides the legal status for use of ARGOS -

-

FAQs -- gives insight to specific features and functionalities of ARGOS based on community’s feedback -

-

 

-

-
-

Main menu - logged in

-

 

-

Extra features

-

 

-

My DMPs - - includes all DMPs which the user is either the owner or the collaborator of -

-

New DMP (Wizard) - - creates DMPs using the Wizard

-

New DMP (Expert) - - creates DMPs using the Expert

-

My Dataset Descriptions - - includes all Dataset Descriptions which the user is either the owner or the collaborator of -

-

Add Dataset Description (Wizard) - - adds Dataset Descriptions to existing DMPs

-

-
-

 

-

Homepage (not signed in)

-

 

-

 

- - - - - - -
-

Statistics

-

Icons showing the number of DMPs, Dataset Descriptions, Grants and Organizations included in ARGOS despite their status (drafts, saved, finalized, published). -

-

 

-

-

 

-

Note! -When logged in to ARGOS the Homepage becomes a personal Dashboard, hence the numbers change to correspond to information provided by the individual’s activity. -

-

 

-

Publicly available DMPs and Dataset Descriptions -

-

The DMPs and Dataset Descriptions that are publicly available in ARGOS. Everyone has access to and may consult them. -

-

 

-

-

 

-

-
-

 

-

Homepage - Dashboard

-

 

-

 

- - - - - - -
-

Login

-

Different login options are available, from social media to research and scholarly communication channels. -

-

-

 

-

Note! -No user account is required.

-

 

-
-

 

-

 

- - - - - - -
-

User Account Menu -[a]

-

This includes two options:

-
    -
  1. Edit your profile details such as name, prefered language etc. -
  2. -
  3. Log out from ARGOS. This terminates your session, so you will be asked to login again next time you visit ARGOS. -
  4. -
-
-

 

-

 

- - - - - - -
-

Latest Activity

-

Name - - the name of the DMP

-

Template - - the DMP template used

-

Grant -- the number of the grant funded the research under which the DMP is conducted -

-

Role -- your role in the different DMPs that you are involved in -

-

Organization - - the organization responsible for the DMP development and delivery -

-

Status - - the status of the DMP development (Draft, Saved, Finalized, Published) -

-

Edited -- date when the DMP was last edited

-

-
-

 

-

 

- - - - - - -
-

Draft

-

The panel shows the DMPs and Dataset Descriptions which are in draft mode by order of the user’s latest activity. -

-

-

 

-
-

 

-

Create DMPs

-

 

-

 

- - - - - - -
-

Using the Wizard

-

 

-

There are three steps involved in creating a DMP when using the wizard: -Funder - DMP Profile - Dataset Description. -

-

 

-

1st step - Funder

-

 

-

Funding organisations

-

In the first drop-down menu, users may find the organisation that their research is funded by. In case that the name of a funding organisation is not in ARGOS, users may create a new record with the name and details of the funding organisation. -

-

 

-

Grants

-

Then, from the following drop-down menu, select the grant that is associated with the research project of the given funding organisation. In case that the grant is not in ARGOS, users may create a new record with the number and name of the grant. -

-

 

-

Projects

-

Select the name of the project that the grant corresponds to. In case that the project is not in ARGOS, users may create a new record with the name of the project and it’s associated grant and funder. -

-

Note! - There may be many projects associated with a grant number.

-

 

-

-

 

-

2nd step - DMP Profile

-

 

-

Name -- title of the DMP

-

 

-

Summary -- brief description of what the DMP is about, it’s scope and objectives -

-

 

-

Dataset Description template - - the description of a dataset according to a set of rules that is the dataset profile -

-

-

 

-

3rd step - Dataset Description

-

Depending of the funding organisation that the DMP concerns, Dataset Description questions differ so that they correspond to and comply with the given organisation’s requirements. -

-

 

-

Note! - A DMP can have more than one Dataset Description templates. -

-

 

-

-

 

-
-

 

-

Using the Expert

-

 

-

There are four steps -involved in creating a DMP when using the Expert. - General and -Grant are by default, while -Dataset Descriptions - and People -appear upon completion of the aforementioned. -

-

 

-

1st step - General

-

Title -[b] -[c] -- title of the DMP

-

Description -[d] -- brief description of what the DMP is about, it’s scope and objectives -

-

Related -[e] -Dataset Description Templates - - the description of dataset according to a set of rules that is the dataset profile(s) -

-

 

-

Organizations - -[f] - The names of the organizations involved in creation and revision of the DMPs. -

-

Researchers -[g] -- the people associated with a role in the DMP development and publishing process. -

-

DMP Template - - the name of the template of the specific DMP. The DMP Template facilitates discovery for re-usability matters (e.g. for future DMPs that are similar to the one indicated under the DMP Template). -

-

 

-

-

 

-

2nd step - Grant

-

This is the same as the 1st step of creating a DMP using the Wizard (check above). It just has a different interface. -

-

-

 

-

Saving the changes made under -General and -Grant -, leads to the next two steps.

-

 

-

-

 

-

3rd step - Dataset Descriptions - 

-

Depending of the funding organisation that the DMP concerns, Dataset Description questions differ so that they correspond to and comply with the given organisation’s requirements. -

-

 

-

4th step - People

-

Includes name, email and editorial permissions of people involved in the creation and publishing of the DMP. -

-

By using the “Invite Contributors”, more collaborators can have rights to edit the DMP. -

-

-
-

 

-

 

-

 

- - - - - - - -
-

Versioning

-

ARGOS provides the possibility of versioning to finalized and/ or published DMPs.

-

 

-

New Version - - starts a fresh version of the existing DMP -

-

All DMP Versions - - shows the history of the different versions of the existing DMP -

-

Clone -- allows for the full content of a DMP to be copied to a new version -

-

Delete -- permanently removes the DMP from ARGOS

-

-
-

Export

-

ARGOS supports download of the DMP records in the following formats: -

-

PDF, Document, XML, JSON -(can be imported to other machine-actionable DMP tools) -

-

 

-

 

-

-
-

 

-

 

- - - - - - -
-

Save DMPs - Wizard

-

 

-

Save

-

Saves all changes made to the DMPs.

-

-

 

-

Finalize saved DMPs

-

After saving a DMP, the DMP record created appears in the user’s dashboard under “My DMPs”. Find the DMP there and click on “finalize” to prohibit further edits to be made. -

-

-

 

-

Publish DMP

-

After saving - and finalizing your DMP, you may decide whether to publish it in the OpenAIRE repository, i.e. Zenodo, by selecting “Publish”. By doing that, -you are redirected to Zenodo where you can -[h] -get a DOI and select the appropriate license for your DMP as an extra output of your research. -

-

-[i]

-

 

-
-

 

-

 

-

Add Dataset descriptions

-

Adds more Dataset Descriptions to existing DMPs.

-

 

- - - - - - -
-

Using the Wizard

-

 

-

There are two steps involved in adding a Dataset Description when using the wizard: -DMP - Dataset Description.

-

 

-

1st step - DMP

-

Selects an existing DMP from the drop-down menu. -

-

-

 

-

2nd step - Dataset Description

-

Selects the template of the Dataset Description that users are required to describe their datasets with by corresponding to their grant funding organisations. -

-

-

 

-
-

 

-

 

-

Using the Expert

-

There are three steps -involved in adding a Dataset Description when using the Expert. - New Dataset Description Details, External References - and Description -.

-

 

-

1st step - -New Dataset Description Details -[j]

-

DMP -- Selects an existing DMP from the drop-down menu. -

-

Dataset Description Template - - the description of dataset according to a set of rules that is the dataset profile -

-

Name of the Dataset Description - - name that facilitates identification of the specific Dataset Description among many Dataset Descriptions of a DMP

-

Uri -- of where the dataset is located

-

Description -- brief description of the dataset described -

-

-

 

-

2nd step - External References

-

This steps refers to datasets that are not created for the given project, rather they are re-used. All fields provide the possibility to upload new information to ARGOS to enrich what is already included in the sources of the Dataset Description Templates. -

-

 

-

Data repositories - - list of repositories where datasets are stored and/ or preserved -

-

External Datasets - - datasets -[k]

-

Registries -[l] -- list of registries for datasets, metadata, vocabularies etc. -

-

Services -- services used for managing datasets throughout the whole research lifecycle -

-

Tags -- keywords facilitating crawling and discovery within ARGOS. -

-

-

 

-

3rd step -- Description -[m]

-

Depending of the funding organisation that the DMP concerns, Dataset Description questions differ so that they correspond to and comply with the given organisation’s requirements. -

-

 

-

 

-

-
-

 

-

 

-

3. User Management

-

Admins - prepare and configure the system. They select and configure information sources and define dataset profiles (templates). -

-

 

-

DMP Managers -launch and finalize DMPs. DMP Managers select appropriate Dataset profiles, invite researchers/ dataset managers for collaborative writing of the DMPs, close the editing process and publish the DMPs (url, pdf, xml etc). -

-

 

-

Researchers/ Dataset Managers -describe datasets according to fixed (systemic) and custom (profile-defined) attributes. -

-

 

-

Add collaborators -allows for more individuals to be given editorial rights to work on the DMP. -

-

 

-
-

[a] -this needs to be done with ARGOS credentials so that it displays ARGOS image -

-
-
-

[b] -change to Name

-
-
-

[c] -for consistency

-
-
-

[d] -change to Summary, for consistency with the Wizard -

-
-
-

[e] -this should be removed

-
-
-

[f] -why don't we keep a registry of orgs?

-
-
-

[g] -aggregate names from the ORCID

-
-
-

[h] -the workflow from the integration is not clear yet -

-
-
-

[i] -this needs update. Publish and Get DOI are the same linking to zenodo workflow -

-
-
-

[j] -change to "Link Dataset Description to DMPs" -

-
-
-

[k] -why can't they upload datasets through zenodo? -

-
-
-

[l]?

-
-
-

[m] -change to "Dataset Description"

-
+ + + +
+

+
+
    +
  1. +

    Entities & Terminology

    +
  2. +
+

Key entities

+

Data Management Plan (DMP) is a collection + of dataset descriptions, associated with an activity (“project” or “grant”). A DMP + may be versioned, is exportable to various forms, currently machine readable (xml, json) and human readable + (pdf/openxml) and can be assigned a DOI and published in Zenodo.

+

+

Dataset in Argos describes data according to a set of rules + that is the dataset template.

+

+

Dataset Template is the set of rules that describe what + Datasets contain and how they are handled. Dataset Templates are modified by Admins and contain + attributes/fields, behavioral rules (e.g. toggling visibility of fields) and validation rules. Dataset + Templates are linked to DMPs so that users are provided with specific formats of descriptions.

+

+

Project is a logical entity that defines the context where + one or more Data Management Plans may be formed in.

+

+

Grant is a logical entity that defines the context where one + or more Data Management Plans may be formed in.

+

+

Users are associated to DMPs and other entities (e.g. + Datasets, Organizations) for authorization and may map to researchers.

+

+

Import - Import function supports upload of + .json files that are produced according to RDA specifications for machine-actionable DMPs

+

+

+ + + + + + +
+

Start New DMP is an easy way to start + writing a DMP. It provides an editor that goes through the essential elements of a DMP and + guides the process of its creation step by step.

+

+

From “Homepage”

+

+

+

From Dashboard

+

+

+

+

+

From “Add Dataset”

+

+
+

+

+ + + + + + +
+

Add Dataset is an easy way + to add new datasets to pre-existing DMPs.

+

+

From Dashboard

+

+

+

From “My Datasets”

+

+

+

From “My DMPs”

+

+

+

From Dataset Editor

+

+
+

+

Secondary entities

+

Repository  - an electronic database or an information + system where data are stored and maintained

+

Data set - a collection of data which are bind together under + a specific format

+

Registry - a database of entities and descriptions

+

Service - a software of specific operations and tasks that + interacts with other software and hardware

+

Researcher - an individual practicing research

+

Funding organization - an organisation that funds research + programmes and/ or researchers’ activities

+
    +
  1. +

    Navigation

    +
  2. +
+

Homepage

+

The homepage can be found under argos.openaire.eu, also accessible from  the OpenAIRE + Service catalogue and the EOSC. +

+

+

+

About - informs about the scope and main functions of the + tool (How it works, ROADMAP, FAQs, Contributors)

+

Resources - provides useful information about using Argos and + includes dissemination material (Media Kit, User Guide, Co-branding)

+

Contact - a contact form that facilitates communication + with Argos team

+

Sign in - enters the tool as a user

+

Login

+

Different login options are available to choose from social media to research and + scholarly communication channels.

+

+

+

Note! No user account is required.

+

+

User Account Menu

+

A dedicated, customisable space of the user’s personal profile.

+

+ + + + + + + +
+

+
+

My profile settings -  displays the + profile page which contains details such as name, email, zenodo account details etc. +

+

+

Associated DMPs - a collection of + users’ DMPs

+

+

Log out - terminates the session, and redirects to + the login page.

+
+

+

+

Main Menu

+

The main menu is located on the left side of the screen. Depending on how users view + the tool, i.e. whether they have logged in or not, the main menu changes to include features that are + available only in individuals’ dashboards.

+

+ + + + + + + +
+

Main menu - not logged in

+

+

+

+

Home  - gets you back to the homepage / + dashboard

+

+

Public DMPs - a collection of DMPs + publicly available in Argos

+

+

Public Datasets - a collection of + Datasets publicly available in Argos

+

+

Co-Branding - a page to view the + software and learn how to contribute

+

+

Support - a contact form that + facilitates communication with Argos team

+

+

Send feedback - a feedback form to + contribute thoughts and opinions about using Argos

+

+

About - informs about the scope and main + functions of the tool

+

+

Terms of Service - provides the legal + status for using of ARGOS

+

+

Glossary - includes the terminology used + in the tool and explains basic components

+

+

User Guide - a guide for users to learn + how to use Argos

+

+
+

Main menu - logged in

+

+

+

+

Home  - gets you back to the homepage / + dashboard

+

+

My DMPs - includes all DMPs which the + user is either the owner or the collaborator of

+

+

My Datasets - includes all Datasets + which the user is either the owner or the collaborator of

+

+

Public DMPs - a collection of DMPs + publicly available in Argos

+

+

Public Datasets - a collection of + Datasets publicly available in Argos

+

+

About - informs about the scope and main + functions of the tool

+

+

Terms of Service - provides the legal + status for using of ARGOS

+

+

Glossary - includes the terminology used + in the tool and explains basic components

+

+

User Guide - a guide for users to learn + how to use Argos

+

+

Contact support - a contact form that + facilitates communication with Argos team

+

+
+

Dashboard

+

Dashboard is the console that appears after entering Argos from the Homepage and + includes condensed information based on Argos function and their use.

+

+

Dashboard - Not logged in

+

+

+

+ + + + + + + +
+

+
+

Latest Activity - displays publicly available DMPs + and Datasets according to the date of their publication in Argos and their Label (DMPs or + Datasets)

+
+

+ + + + + + + +
+

+
+

Public Usage - shows the number of + publicly available DMPs, Datasets, Grants and Organizations included in Argos

+

+

Note! When logged in to ARGOS the Homepage becomes a personal + Dashboard, hence the numbers change to correspond to information provided by the + individual’s activity.

+
+

+

Dashboard - Logged in

+

+

+

+

+ + + + + + + +
+

+
+

Latest Activity - displays users’ DMPs and + Datasets classified according to the date of their last modification, the status of the + document (draft, finalized, published) and their label (DMPs or Datasets)

+
+

+ + + + + + + +
+

+
+

Personal Usage - shows users activity in + DMPs, Datasets, Grants and Organizations

+
+

+

My DMPs / My Datasets

+

Contains all DMPs and Datasets which the user is either the owner or the collaborator + of. Both DMPs and Datasets on the user dashboard are classified by the date of their last modification, the + status of the document (draft, finalized, published) and their label (DMPs or Datasets).

+

+

My DMPs

+

Each DMP card is green and shows the role of the person + viewing the DMP, the status of the writing process, the version of the current DMP, the grant associated + with the DMP, the number and name of datasets that the DMP has.

+

+

+

Export - supports download of the DMP outputs in the + following formats: PDF, Document, XML, RDA JSON (can be imported to other RDA compliant DMP tools) +

+

Add Dataset - adds more Datasets to existing DMPs +

+

Invite - provides people with edit rights on the + document

+

Clone - creates an exact replica of the DMP

+

+ + + + + + + +
+

+
+

New version - starts a new version of + the DMP

+

All DMP Versions  - shows the history of + the different versions of the existing DMP

+

Delete - permanently removes DMPs +

+

+
+

+

+

My Datasets

+

Each Dataset card is yellow and shows the + role of the person viewing the Dataset, the status of the writing process, the grant associated with the DMP + and the tite of the DMP that the dataset is part of.

+

+

Export - supports download of the DMP outputs in the + following formats: PDF, Document, XML, RDA JSON (can be imported to other RDA compliant DMP tools) +

+

Invite - Sends email or searches the Argos Users Catalogue to + find colleagues/ collaborators. Invitation sent provides people with edit rights on the document.

+

+

+ + + + + + + +
+

+
+

Copy Dataset - creates a copy of the + dataset

+

Delete - permanently removes + Datasets

+
+

Public DMPs / Public Datasets

+

Contains DMPs outputs that are openly available in Argos. That means that DMP owners + and members are making their DMP and/or Dataset outputs available to all Argos and non-Argos users who might + want to consult or re-use them under the framework provided by the assigned DMP license.

+

Both DMPs and Datasets on the user dashboard are classified by the date of their last + modification and their label (DMPs or Datasets). Users can also search for the DMP or Dataset from the + search bar.

+

+

Public DMPs

+

+

Each Public DMP card is green and displays + the title of the DMP, its status (published), the version of the DMP, the grant associated with it, the + number and name of datasets that the DMP contains.

+

+

+

Export - supports download of the DMP outputs in the + following formats: PDF, Document, XML, RDA JSON (can be imported to other RDA compliant DMP tools) +

+

Clone - creates an exact replica of the DMP

+ + + + + + + +
+

+
+

All DMP Versions - shows the history of + the different versions of the existing DMP

+

+
+

+

+

Public Datasets

+

Each Public Dataset card is yellow and + displays the title of the dataset, the status of the dataset (published), the grant associated with the DMP + and the title of the DMP that the dataset is part of.

+

+

Export - supports download of the DMP outputs in the following + formats: PDF, Document, XML, RDA JSON (can be imported to other RDA compliant DMP tools)

+ + + + + + + +
+

+
+

Copy Dataset - creates a copy of the + dataset

+
+

Create DMPs

+

There are many ways to create new DMPs in Argos.

+

+

Start new DMP - Start Wizard

+

+

+

There are four steps involved in creating a DMP: Main Info - + Funding Info - License Info - Dataset Info

+

+
    +
  1. Main Info
  2. +
+

+

+

+

+

Title - title of the DMP

+

Description - brief description of what the DMP is + about, it’s scope and objectives

+

Language - the language of the DMP

+

Visibility - how the DMP is displayed in Argos. By + choosing Public, the DMP is automatically made available to all users from the “Public DMPs” + collection.

+

Researchers - the people that have produced, processed, + analysed the data described in the DMP

+

Organizations - the names of the organizations contributing + to the creation and revision of the DMPs

+

Contact - the contact details of the DMP owner

+

+
    +
  1. Funding Info
  2. +
+

+

Funding organizations - A drop-down menu where users may find the + organisation that their research is funded by. In case that the name of a funding organisation can not be + found in Argos, users may create a new record with the name and details of the funding organisation + (“Insert it manually”).

+

Grants - A drop-down menu to select the grant that is + associated with the research project of the given funding organisation. In case that the grant can not be + found in Argos, users may create a new record with the number and name of the grant (“Insert it + manually”).

+

Project - This field is to be completed only for projects + where multiple grants apply. Otherwise, it is left blank and is later filled automatically by Argos + metadata.

+

+

Note!  There may be many projects associated with a grant number.

+

+
    +
  1. License Info
  2. +
+

+

License - A list of licenses to choose from and assign to + DMPs

+

+
    +
  1. Dataset Info
  2. +
+

+

Dataset Info - Select a template to describe your datasets. + You may select more than one template.

+

+

Save DMPs

+

Discard - undo all changes made to the dataset

+

Save - keeps all changes made to the DMP and continues work on the same + page

+

Save & Add Dataset - keeps all changes made to the DMP + and the Dataset editor starts to describe the first dataset of the DMP

+

+

+

Add Dataset(s)

+

There are two ways to create datasets: when creating the first dataset of the DMP and + when adding datasets to existing DMPs. Add datasets are linked to and are associated with at least one DMP + in Argos. A dataset can not exist as an orphan record.

+

+

First dataset

+

+

Once the DMP is created, the user can fill in the description for their data in the + Dataset Editor.

+

+

Add dataset - Adds more Dataset to existing DMPs

+

There are three steps involved in adding a Dataset: Select a DMP for your Dataset - + Select Template - Edit Dataset

+

+
    +
  1. Select a DMP for your Dataset
  2. +
+

+

Selects an existing DMP from the drop-down menu

+

+
    +
  1. Select Template
  2. +
+

+

Selects the template of the Dataset that users are required to describe their + datasets with by corresponding to their grant funding organisations.

+

+
    +
  1. Edit Dataset
  2. +
+

+

A Dataset Editor to add information that describes management activities according to + the selected template.

+

+

Save Datasets

+

There are many ways to Save a DMP in Argos. They all serve the same function, but the + difference lies in the follow up action.

+

+

+

Discard - undo all changes made to the dataset

+

Save - keeps all changes made and continues work on the same + page

+

Save & Close - keeps all changes made, but the editor’s window + closes and the user is redirected to their dashboard

+

Save & Add New - keeps all changes made and a new editor + starts to describe a new dataset

+

DMPs/ Datasets records

+

Records of DMPs and Datasets in Argos after editing and after finalization. +

+

Users can view the DMPs and Datasets they create from their dashboard. By opening a + record they have created, they are provided with additional functionalities that are binded to the + completion of the DMP writing process. Different functionalities apply according to the status of the DMP, + i.e. before or after the DMP finalization.

+

+

DMPs before finalization

+

+

Before finalization, the DMP can be further edited, deleted or cloned. Users can + review information that they have added regarding grant, researchers, DMP description and datasets used. New + datasets can be added at any time from this page. Users can export the DMP, they can start working on a new + version and/ or invite colleagues to collaborate on completing the DMP.

+

+

Invite

+

+

+

DMPs after finalization

+

+

After the DMP finalization, the DMP can be made publicly visible in Argos and + deposited in Zenodo. Users can export the finalized DMP, they can start working on a new version and/ or + invite colleagues to collaborate on completing the DMP. Finalization is possible to be reverted.

+

+

Datasets before finalization

+

Argos offers different options before and after the Dataset finalization.

+

+

+

Before finalization, the Dataset can be further edited, deleted or cloned. Users can + access the whole DMP that the dataset is part of from that page and review information that they have added + regarding grant, researchers and Dataset description. Users can export the description of the dataset and + invite colleagues to collaborate on its completion.

+

+

Datasets after finalization

+

+

After finalization, the Dataset can be exported and shared with colleagues for + review.

+

+

+

+

+

+ \ No newline at end of file