/
Data Import Reporting a Bug

Data Import Reporting a Bug

Use these guidelines to report bugs with the Data Import module or settings (profiles). For the purposes of this documentation and reporting, any functionality or behavior in the Data Import nodules that is not working as expected or has changed unexpectedly should be filed as a bug in Jira.

Before creating a new Jira:

  1. Reproduce the issue in bugfest (the same flower version as the environment in which the bug was discovered) or FOLIO Snapshot.

  • Create a data import job profile and MARC record or other scenario to reflect the same conditions as in the local environment.

  • Perform the same actions in the FOLIO Snapshot and Bugfest environments and evaluate the outcome to determine if the bug behavior is reproduced in the shared environments.

  • If the bug is isolated to the local environment only, be sure to check with the hosting provider or local support.

  1. Check in with colleagues on Slack or in the Data Import Lab to see if any community members are also observing the issue.

  • Post on Slack in #data-import-sig-lab. Provide the following information if you can:

    • A description of the observed behavior.

    • A screenshot of the hob profile components.

    • A sample MARC record.

    • The flower release and CSP for the FOLIO version, e.g., Ramsons CSP4.

  • And/or share the issue in a Data Import Lab Session on Thursdays from 3-4pm ET.

    • Posting first in the Slack channel that you will be sharing an issue ensures that interested people will be present at the meeting if they can.

  1. Verify that there is not a bug in Jira already.

    • Search Jira for similar issues or bugs.

Once you have reproduced the behavior and confirmed that the issue has not been reported in Jira already, the next step is to create a new bug in Jira for the issue.

  1. How to report a bug in the FOLIO Community Jira:

  • Log in to Jira at https://folio-org.atlassian.net/issues.

  • Click on +Create. The button is located to the right of the search box at the top of the page.

    image-20250910-182338.png
    Create Button in FOLIO Jira Project

  • Provide the following information about the bug. Any fields not mentioned do not need to be populated.

    • Space: “mod-data-import (MODDATAIMP)”

    • Work type: “Bug”

    • Summary: This is the title of the issue. Add just enough information that captures the core of the issue

    • Description: Provide the following information about the issue.

      • Describe the error. Include information about what actually happened and what was expected to happen.

      • If the issue is reproduceable in Bugfest, provide a link to a job import profile in a Bugfest environment that can be used to reproduce the issue. If this is not possible, attach screen shots of a job import profile and information about how to recreate the import profiles. If one is available also provide a link to job in the log with records that exhibit the bug behavior. Attach a MARC file that can be used with the job profile or provide instructions for creating a file of MARC records that can be used to reproduce the problem.

      • Provide any information about recorded meetings where the issues was discussed, such as in the Data Import SIG or Data Import Lab. Include a link to the recording if one is available.

      • @Ryan Taylor (Data Import product owner) in the description.

    • Development Team: “FOLIJET”

    • Labels: “support”, “data-import-sig-needs-review”

    • Just start typing the label and it will appear in the list. If you do not have permission to add labels, ask in Slack and a convener will add them for you.

    • Environment: Describe the environment(s) in which you tested in such as flower version and CSP

    • Potential Workaround: Describe any workarounds. If there are no workarounds be sure to note that.

    • Affected Institution: “All” or your institution. (use All when you know that others are also experiencing the same issue.)

    • Attachment: Attach any screenshots, recordings, or MARC files to support reproduction and understanding of the issue.

    • Affected releases: Select all of the flower versions in which the bug has been confirmed.

  • Click the Create button in the lower right corner to save the Jira.

  • A pop-up in the lower left corner will contain a link that can be used to open the newly created Jira. Copy the link and paste it into the #data-import-sig-lab Slack channel to notify the community about the new bug. At this point you can ask for help assigning labels or providing any other information.