The Integrations Dashboard is software from the Dataverse community to enable easy transfer of data from an existing data management platform  ( Github, Gitlab, IRODS...) to a dataset in a Dataverse collection.

Versió en català

Videotutorial sobre Integrations Dashboard (CSUC)

Videotutorial (Dataverse)

All documentation about integration Dashboard is in: libis/rdm-integration: Integration tool for importing data to Dataverse  

Go to the Github page (Releases · libis/rdm-integration (github.com))and download the executable file depending on the version of the Operating system you have.

Windows

  • demo_windows.exe

macOS

  • Mac with Intel → demo_darwin_amd64.bin

  • Mac with Apple Silicon (M1/M2/M3) → demo_darwin_arm64.bin

Linux

  • demo_linux.bin


Once the file is downloaded, you can decide to save it in a specific folder or leave it in the downloads folder. It is important to know where the file is located for the next steps.


Open the Terminal of the operating system you are using.

Windows

  • Win → write cmd o PowerShell → Enter

macOS

  • Launchpad → Other → Terminal

Linux

  • Ctrl + Alt + T

  • or Aplications → Terminal

For example, on Windows:

In the Terminal, navigate to the source folder where the executable is located.

Common comands

  • ls # llistar fitxers cd carpeta # entrar a una carpeta

Exemples

  • Windows (PowerShell):
  • cd Desktop\Integrations_Dashboard

macOS / Linux

  • cd ~/Desktop/Integrations_Dashboard

Comprove if you have the file

  • ls

For exemple Windows, the command 'ls' + 'enter key' helps to know the location where the user is with the files or folders inside.

To locate the source folder, it is necessary to open and move between folders using the command 'cd' + 'Folder Name or Path' + 'Enter key'.

For example if we want to open the 'Downloads' folder, we must write 'cd Downloads'. If we want to open another folder, the folder path must be written separated by '\'.

In the following image, the executable has been saved to a folder named 'Integrations_Dashboard' located under 'Desktop'. Therefore in the terminal you must write: 'cd Desktop/Integrations_Dashboard' + 'enter key'.

In the image above, with the 'ls' command you can see that there is the file 'demo_windows.exe' inside this directory.

To run the program on macOs or Linus, the permissions must be given

macOS / Linux:

  • chmod +x demo_darwin_amd64.bin

or

  • chmod +x demo_darwin_arm64.bin

or

  • chmod +x demo_linux.bin

For Windows, type the command '.\demo_windows.exe -server=https://dataverse.csuc.cat -servername="Repositori Dades de Recerca" -dvID=cat' and click Enter.

Windows

macOS (Intel)

macOS (Apple Silicon)

Linux

A window or tab will open in your default internet browser:


In the 'Data/code source' dropdown there are options to choose the source from which the data will be transferred to the repository. It should be borne in mind that the data must already be hosted on the platform of origin. These provenance options are:

  • Local Filesystem: Local file system of a computer or server to store and manage data directly.
  • GitHub: Git-based platform for collaborative software development and source code hosting.
  • GitLab: Open source DevOps environment for Git repository management and continuous integration.
  • iRODs: Open-source distributed data management system for large-scale file control and sharing.
  • REDCap: Secure data management platform for research, especially in the biomedical and academic fields.
  • OSF (Open Science Framework): Platform for the management, collaboration and sharing of open research projects.
  • Dataverse: A research data repository that enables the publication, preservation, citation and sharing of data.

Depending on the provenance chosen, certain variables will be required such as a Token, URL, name of the repository among others. All these variables refer to the origin of the data and not the RDR.

In the 'Research Data Repository' tab, fill in the following variables:

  • Token: Unique secret key for each RDR user. As a minimum requirement, the user must have the role of Curator or Contributor.
  • Dataverse Collection: Instance where the previously created dataset is located. You can search by full name or by acronym.
  • Dataset DOI: DOI of the dataset which is searchable in the list or with the URL.

Once all the origin and RDR variables have been filled in, click the 'Connect and Compare' button

The page will refresh and display two columns with the file names. The left column lists the files found in the source source and the right column lists the files found in the dataset in RDR if any.

  • If you want to transfer a file from the source you have to click the box, it will turn green and appear in the other column.
  • If you want to replace a file with the same name, click on the box, it will turn blue and in the other column the name will appear in bold.
  • If you want to delete a file from the dataset, click the box, it will turn red and the name will appear crossed out.
  • If you don't want to transfer a file, don't click anything.
  • If a folder structure exists, it is also possible to transfer, delete or replace all the files inside with a single click.

Clicar 'Submit' per guardar els canvis al repositori. A continuació apareixeran els canvis que es realitzaran:

Click 'Submit' again and the message 'Click on "OK" to start the update/transfer. You can close the window and the transfer will continue.'. If you agree, click OK.

Wait for all the changes to be made, and the page will be updated with the changes made. There is also the option to go to the dataset by clicking the 'Go to dataset' button.