Configuring Record Types in ReDBox

This section covers configuring different record types within the ReDBox platform, an essential step for tailoring the application to meet specific institutional and research data management requirements.

Overview of Record Types

Record types in ReDBox allow for the categorization and management of different sets of data, reflecting the diverse workflows and data needs within research institutions. They are pivotal in structuring the ReDBox platform to accommodate various data management practices.

Understanding packageType

The packageType attribute plays a significant role in the ReDBox configuration. It is utilized to bundle similar record types together, particularly in certain views within the ReDBox UI. This bundling is crucial for organizing records into logical groupings, making them easier to manage. Commonly, packageType is used for ReDBox Workspace records to group the various workspace types together into the one view.

Configuring Your Record Types

When configuring your record types in ReDBox, you will modify settings within the config/recordtype.js file. Here's a basic structure to guide you:

module.exports.recordtype = {
  "rdmp": {
    "packageType": "rdmp",
    "hooks": {...},
    "relatedTo": [...],
    "searchFilters": [...]
  },
  "dataRecord": {...},
  // Additional record types can be added here.
};

Key Components

• packageType: Define this to group similar record types, enhancing UI organization and functionality.
• hooks: Implement custom logic at various lifecycle stages of a record, such as creation or update.
• relatedTo: Set up relationships between different record types for data linkage and integrity.
• searchFilters: Define how records of this type can be searched within the platform using custom filters.

Steps for Customization:

1. Define New Record Types: Add configurations for new types as necessary, following the structure outlined above.
2. Implement Hooks and Logic: Based on your workflows, customize the hooks to perform actions during record lifecycle events.
3. Establish Relationships: Use the relatedTo component to link related record types within your data ecosystem.
4. Customize Search Capabilities: Tailor searchFilters to enhance the discoverability of records based on relevant criteria.

Further Information

By correctly configuring record types, you ensure that the ReDBox platform aligns seamlessly with your institution's data management processes and meets your specific needs.