[Share] Convert Rayyan Include/Exclude and Labels to Zotero Tags

[rummens]

Description

I am using Rayyan for Paper Screening and I wanted an easy way to import things back to Zotero. This can be achieved by exporting the Rayyan Articles into RefMan or similar and import them into Zotero. This will create a Note under each item in a certain format. Running this Action against it will create a Tag for Include/Exclude, as well als Labels and Exclude Reasons defined.
I only tested this with a Single Reviewer. As the Note contains the Names of every Reviewer, this script might be confused if the Reviewers don't agree on a certain paper.

Event

None

Operation

Script

Data

/**
 * Takes a Note, imported from Rayyan, and as the corresponding Tag to the Item.
 * @author Zotero Community
 * @usage 
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/
 */

const Zotero = require("Zotero");
const window = require("window");

(async function () {
    const startTime = new Date();
    const keywordTagMap = {
        'Excluded': 'Excluded',
        'Included': 'Included'
      };
     
    const includePrefix = "RAYYAN-INCLUSION";
    const labelPrefix = 'RAYYAN-LABELS: ';
    const exclusionPrefix = 'RAYYAN-EXCLUSION-REASONS: ';

    // Prevent duplicate execution
    if (window.batchTagRunning) return;
    window.batchTagRunning = true;

    // Get items to edit based on user selection
    async function getItemsToEdit(triggerType, item, items) {
        const zoteroPane = Zotero.getActiveZoteroPane();
        if (triggerType === 'menu') {
            if (items && items.length > 0) {
                return items;
            } else if (item) {
                return [item];
            } else {
                window.alert("No items selected.");
                return null;
            }
        } else {
            let selectedItems = zoteroPane.getSelectedItems();
            if (!selectedItems.length) {
                window.alert("No items selected.");
                return null;
            }
            return selectedItems;
        }
    }

    // Log the elapsed time for a given operation
    function logTime(label, time) {
        try {
            Zotero.logError(`${label}: ${(time / 1000).toFixed(2)} seconds`);
        } catch (error) {
            Zotero.logError(`Failed to log time for ${label}: ${error.message}`);
        }
    }
    
    try {
        // Ensure items and item are provided
        if (!items && !item) {
            window.alert("Bulk Edit", "No item or items array provided.");
            window.batchTagRunning = false;
            return;
        }

        // Get items to edit based on user selection
        let itemsToEdit = await getItemsToEdit(triggerType, item, items);
        if (!itemsToEdit) {
            window.batchTagRunning = false;
            return;
        }

        Zotero.logError(`Total items to edit: ${itemsToEdit.length}`);

        for (let item of itemsToEdit) {
            // Skip if the item is of type 'note'
            if (item.isNote()) {
              continue;
            }
        
            // Get the notes for the item
            const noteIDs = item.getNotes();
            const notes = await Zotero.Items.get(noteIDs);
        
            for (let note of notes) {
              const noteContent = note.getNote();
        
              // Check for predefined keywords
              for (const [keyword, tag] of Object.entries(keywordTagMap)) {
                if (noteContent.includes(includePrefix) && noteContent.includes(keyword)) {
                  item.addTag(tag, 1);
                  Zotero.logError(`Added tag: ${tag} to item: ${item.id}`);
                  break; // Exit the loop if the keyword is found
                }
              }
        
              // Check for labels
              const labelIndex = noteContent.indexOf(labelPrefix);
              if (labelIndex !== -1) {
                let allLabels = noteContent.substring(labelIndex + labelPrefix.length).split(',');
                for (let label of allLabels) {
					label = label.replace(/<\/?[^>]+(>|$)/g, ""); // Remove HTML tags
					label = "Label-" + label
					item.addTag(label, 1);
					Zotero.logError(`Added tag: ${label} to item: ${item.id}`);
				}
              }
              
              // Check for exclusion reasons
              const exclusionIndex = noteContent.indexOf(exclusionPrefix);
              if (exclusionIndex !== -1) {
				let allExcklusions = noteContent.substring(exclusionIndex + exclusionPrefix.length).split(',');
                for (let exclusionReason of allExcklusions) {
					exclusionReason = exclusionReason.replace(/<\/?[^>]+(>|$)/g, ""); // Remove HTML tags
					const exclusionTag = `Exclusion-${exclusionReason}`;
					item.addTag(exclusionTag, 1);
					Zotero.logError(`Added tag: ${exclusionTag} to item: ${item.id}`);
				}
              }
            }
          }

        
    } catch (error) {
        Zotero.logError(`Error in batch tag script: ${error.message}`);
        window.alert(`An error occurred: ${error.message}`);
    } finally {
        window.batchTagRunning = false;
        const endTime = new Date();
        logTime("Total time", endTime - startTime);
    }
})();

Anything else

I reused some Code from Batch Tag Operations