Step 1 (continued): Upload and Describe an Artifact

This page is the second part of Step 1 of the RDMC Creation Workflow. You come here right after you create an artifact on Step 1: Artifact Initialization. It has three parts, which you go through in order:

  1. Resource Upload — add the content of the artifact: files, folders, software, another RDMC, or links (URL/DOI).

  2. Artifact Details — describe the artifact so others can understand it.

  3. Artifact Summary — check everything you added, add another artifact, or go on to Step 2, Step 2: Execution Environment.

Part 1: Resource Upload

This step guides you through uploading resources to your container. Resources can be files, folders, or links. Each resource needs a descriptive title.

Resource Upload

Figure: Post-Upload Platform View

Upload Process

1. Title

Give the resource a clear, descriptive title. This field is mandatory.

2. Resource Types

Each resource must be assigned one or more types:

  • Data: General research data such as datasets, tables, measurements, or supporting data files.

  • Software: General software engineering artifacts such as source code, scripts, libraries, tools, or executables.

  • RDMC: Connects a previously created Research Data Management Container (RDMC) to the current container.

  • RDMC + REE: Connects a previously created RDMC that includes a Reusable Execution Environment (REE) to the current container.

Note

Currently, RDMC and RDMC + REE only record the selected type label and do not trigger any backend linking or processing yet.

3. Resource Location

Choose where the resource comes from.

  • Type of Resource: Select one or more resource types.

  • Resource URL: Enter the URL of the external repository. If something does not work, see:

  • Repository Platform: Select the platform type (for example, GitHub, GitLab, Zenodo, OSF, Codeberg, Gitea, Bitbucket, or Software Heritage). The platform configuration can limit which platforms are available.

  • Import Method:

    • Save as URL: Store the link as it is, without downloading.

    • Download Repository: Download the repository content.

  • Version Selection (GitHub, GitLab, or Zenodo): Click See Available Tags or Releases to open a pop-up.

    • For GitHub and GitLab, you can select a tag or release. This is optional.

    • For Zenodo, the pop-up lists all published versions, newest first. Each version shows its DOI and publication date. The pop-up also shows the concept DOI that covers all versions.

  • Click Validate to complete the upload.

Resource Upload 2

Figure: Link Upload Form

  • Type of Resource: Select one or more resource types.

  • Upload Options:

    • File Upload: Click Upload Resources and select one or more files.

    • Folder Upload: Check the Folder Upload box, then select a folder.

  • Review the validation results for the folder structure. For details, see folder validation.

  • Click Validate to complete the upload.

Note

Uploading physical files from your device is enabled on the Stable website (and in local deployments where RDMC_RUN_AS_DEMO=False in .env). On the Demo website, physical file uploads are disabled — use external URLs instead.

Resource Upload 3

Figure: Folder Validation Pop-up

4. Review or Delete

Uploaded resources are listed on the right. You can review or delete them there.

Note

  • A success message appears after a successful upload.

  • An error message appears for duplicate titles and for duplicate files or URLs.

  • If a Git repository URL points to a repository with a citation file, the citation is displayed.

Resource URL Not Supported?

If the platform in your link is not known to the system, a pop-up window opens. An alert message also appears under the Resource URL field.

  1. Check that the link is correct.

  2. Click Ask us to add this repository.

  3. Fill in the form.

  4. Click Send request.

After an admin approves the platform, you can add the URL.

Note

  • This feature is only available for Git repositories.

  • If you already sent a request, contact the administrator through the NFDIxCS Helpdesk.

Requesting a new repository platform

Figure: Requesting a New Repository Platform

Private Repository Not Accessible?

If the repository cannot be opened, a Personal Access Token window appears after you click Validate.

  1. Check that the Resource URL is correct.

  2. If the repository is private, create a read-only token on your platform. Choose the tab for your platform:

    1. Go to Settings ‣ Developer settings.

    2. Select Personal access tokens ‣ Fine-grained tokens.

    3. Click Generate new token.

    4. Under Repository permissions, set Contents to Read-only.

    1. Go to Project Settings ‣ Access tokens.

    2. Click Add new token and enter a name.

    3. Under Scopes, select read_api and read_repository.

  3. Paste the token into the window and click Validate Token & Continue.

Important

Never share your Personal Access Token with others.

Note

This feature is only available for Git repositories.

Personal Access Token

Figure: Personal Access Token

Part 2: Artifact Details

After you upload the resources, you need to give more information about the artifact.

  • The artifact details are captured with HPC-related questions.

  • This information also supports the Artifact Evaluation track.

  • Answer the questions and click Save & Continue.

  • A success message appears once the details are saved.

Artifact Details Questionnaire

Figure: Artifact Details Questionnaire

Part 3: Artifact Summary

The Artifact Summary page gives an overview of all artifacts. For each artifact, you can see:

  • Artifact Name

  • Resources, with a link back to the uploaded resources of the artifact

  • Upload Status, which shows whether the artifact has uploaded resources.

  • Artifact Details, with the options View, Modify, and Download (see Part 2: Artifact Details)

After you review the artifacts, click one of these buttons:

Note

The Download option is only available if the organizer enabled the Artifact Download feature on the platform. See Configuration Features.

Artifact Summary

Figure: Artifact Summary Page