Usage

Usage is role-dependent and there are three roles of authorized users: Researcher, Data Steward, and Administrator. Higher-level role can do the same as lower-level role and also something more, so let’s describe it from the simplest one…

Anonymous

User of DSW that is not logged in yet is able to register, log in, or recover forgotten password via confirmed email address.

Researcher

Researcher is a user who works on a scientific project and has the knowledge about the specific project. His/her goal is to get high-quality FAIR Data Management Plan and learn how to work with data in the project.

Projects

Data Stewardship Wizard provides simple way to create project using a KM package and fill the questionnaire in smart way - only relevant questions for your case will be shown.

  • Create = create new project using a certain version of certain KM package

  • For each project:

    • Open project = starts interactive questionnaire that guides you through answering relevant questions for specific project

    • Clone = create a duplicate project

    • Create Migration = migrate project to a different version of KM

    • Delete

  • When you open a project, you can use:

    • Share = permissions for other registered and anonymous users with the project links (read-only or edit)

    • Questionnaire = questionnaire based on the selected KM, auto-saving, you can switch the current phase

    • TODOs = list of questions marked as TODO in questionnaire

    • Metrics = visualization of metrics

    • Preview = preview of a document (default template must be set in Settings)

    • Documents = list of all generated documents for this project

    • Settings = change name, set default template, or delete project

Documents

This section displays all documents (or DMPs) for the project. You can download the document, delete it, or navigate to questionnaire used for the DMP. If there is a submission service configured for the template, you may submit such documents.

Settings

You can change name of a project, the default document template and format, or delete the project entirely.

Data Steward

Data Steward is a user who has good knowledge of DS domain (how to deal with data) and puts this knowledge into a knowledge model. The knowledge model is then used by scientists to create the DMP with Questionnaire.

Knowledge Models

Knowledge Models are collections of DS knowledge. Each package has own unique identifier consisting of organization ID and km ID (and then also version). It stores all the knowledge units = changes of “zero” knowledge (add, delete, edit - chapter, question, answer, reference, etc.).

  • Import = import new KM package or new version of KM package from file or from Registry

  • For each KM package:

    • Delete

    • View detail = shows detail with versions and basic information about the KM and for each version:

      • Export = export specific version of KM, that can be then imported (e.g. in different instance of DSW)

      • Create KM Eitor = shortcut to create editor from specific version of KM

      • Create Questionnaire = shortcut to create planner from specific version of KM

      • Delete

KM Editor

Knowledge Model Editor allows to create new knowledge models:

  1. from scratch (i.e. totally new root KM package)

  2. as new version of existing KM package (i.e. some improvements needs to be done)

  3. as a customization of an existing KM package (i.e., extension for specific subdomain - can be based on organizational, geographical, legal or other expertise)

  • Create = create editor with specific name and KM ID, optionally based on some parent KM.

  • For each KM editor:

    • Open Editor = shows editor that allows to go through the all parts of KM, create new parts, edit or delete them.

    • Delete

    • Publish (if changes are made) = create KM with specific version and description of changes

    • Upgrade (if newer version of parent KM) = migrate to newer version of parent KM in interactive migration tool

Administrator

Administrator manages overall settings of the Data Stewardship Wizard instance and has the highest privileges.

Organization

Administrator can set two things in organization settings:

  • Organization name = visible name of the organization that uses DSW instance

  • Organization ID = unique identifier of the organization, it is then used in identifier of created Knowledge Models

Users

User management is also quite simple. Administrator can see table with registered users, Delete or Edit single one of them, or Create User directly. When editing the user, it is possible to change all the attributes from registration and also manually change the “Active” status.

Settings