Skip to content

Commit

Permalink
update content for features
Browse files Browse the repository at this point in the history
Add some basic styling.
  • Loading branch information
cofiem committed Sep 18, 2024
1 parent 868d5a4 commit 6c0f161
Show file tree
Hide file tree
Showing 12 changed files with 237 additions and 303 deletions.
2 changes: 1 addition & 1 deletion .support/generate_latest_release_info.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ PUB_DATE=$(jq -r '.published_at | fromdateiso8601 | strftime("%a, %d %B %Y")' "$
# e.g. The [most recent ReDBox version is <tag_name>](<html_url>) released on [<published_at>].
# e.g. The [most recent ReDBox version is *v3.6*](https://github.com/redbox-mint/redbox-portal/releases/tag/v3.6) released on 01 May 2024.

echo "The [most recent ReDBox version is *${VERSION}*](${URL}) released on ${PUB_DATE}." > "${HTML_FILE}"
echo "The <a href='${URL}'>most recent ReDBox version is <strong>${VERSION}</strong></a> released on ${PUB_DATE}." > "${HTML_FILE}"
5 changes: 5 additions & 0 deletions _includes/figure_image.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<figure class="figure">
<img src="{{ include.src }}" class="figure-img img-fluid rounded border" loading="lazy"
style="max-width: {{ include.max-width }};" alt="{{ include.alt }}"/>
<figcaption class="figure-caption">{{ include.caption }}</figcaption>
</figure>
2 changes: 1 addition & 1 deletion _includes/html_body_footer.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<footer class="container">
<footer class="container border-top mt-5">
<p class="float-end">
<a href="#top">Back to top</a>
</p>
Expand Down
2 changes: 0 additions & 2 deletions _layouts/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ <h1 class="text-body-emphasis">ReDBox</h1>
</div>

<div class="container marketing">

<!-- Three columns of text below the carousel -->
<div class="row">
<div class="col-lg-4">
<i class="bi-card-checklist data-lifecycle-item"></i>
Expand Down
44 changes: 21 additions & 23 deletions data-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@ their research data as well as the eResearch infrastructure and services used to
ReDBox supports the DLCF by assisting users to provision and manage storage infrastructure,
then allowing users to extract manifests of data back into ReDBox and publishing the data files
alongside the data collection metadata.
alongside the data collection metadata.

<img src="{{ '/static/images/curationlifecycle.png' | relative_url }}"
class="img-fluid border"
alt="How ReDBox supports the DCC Curation Life Cycle">

How ReDBox supports the DCC Curation Life Cycle
{% capture figure_src_curation_lifecycle %}{{ '/static/images/curationlifecycle.png' | relative_url }}{% endcapture %}
{% include figure_image.html
src=figure_src_curation_lifecycle
max-width="800px"
alt="How ReDBox supports the DCC Curation Life Cycle"
caption="How ReDBox supports the DCC Curation Life Cycle"
%}

## The Research Activity Portal and RAiDs

Expand Down Expand Up @@ -63,11 +64,13 @@ functions, including:
Future Provisioner development is expected to support many more useful processes, including data archiving
and data publication.

<img src="{{ '/static/images/provisioner.jpg' | relative_url }}"
class="img-fluid border"
alt="The UTS Provisioner links services to their Stash research data management platform via workspaces">

The UTS Provisioner links services to their Stash research data management platform via workspaces
{% capture figure_src_provisioner %}{{ '/static/images/provisioner.jpg' | relative_url }}{% endcapture %}
{% include figure_image.html
src=figure_src_provisioner
max-width="800px"
alt="The Provisioner links services to their research data management platform via workspaces"
caption="The Provisioner links services to their research data management platform via workspaces"
%}

## ReDBox and Data Harvesting

Expand All @@ -78,22 +81,17 @@ manifest of the files, and harvest the manifest (and optionally the data files)
research data files under ReDBox and institutional control. The files and metadata can then be published for
open access.

## ReDBox in the Cloud

With ReDBox, QCIF are using a new web development framework that will allow QCIF to move beyond hosting individual
ReDBox Lite instances to providing the full ReDBox functionality in the Cloud using the Software as a Service (SaaS)
model. The Research Activity Portal can already be extended to provide the Data Management Planning Tool for institutions.

## The Benefits of ReDBox as a Research Data Management Platform

Through this approach researchers will have ReDBox as a single point of access to key elements of the DLCF,
including planning, provisioning, data harvesting and publishing. It will give institutions greater visibility
into how researchers manage and publish their data while providing assurances that researcher practices conform
to Australian standards and expectations.

<img src="{{ '/static/images/rbdlc.jpg' | relative_url }}"
class="img-fluid border"
alt="The UTS Provisioner links services to their Stash research data management platform via workspaces">


ReDBox is a complete data management system for supporting the Research Data Life Cycle Framework
{% capture figure_src_rbdlc %}{{ '/static/images/rbdlc.jpg' | relative_url }}{% endcapture %}
{% include figure_image.html
src=figure_src_rbdlc
max-width="800px"
alt="ReDBox is a complete data management system for supporting the Research Data Life Cycle Framework"
caption="ReDBox is a complete data management system for supporting the Research Data Life Cycle Framework"
%}
13 changes: 0 additions & 13 deletions features.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,6 @@ Research data management planning is now encouraged in all Australian Universiti
ReDBox provides customisable forms and workflows to assist researchers, supervisors and administrators in creating,
tracking and approving DMPs.

## ReDBox Lite

ReDBox Lite is a simplified metadata management version of ReDBox
It supports standardized metadata record types, and has reduced scope for integration with other systems.
It does not require advanced administration techniques or application programming skills.
ReDBox Lite assists research institutions and communities to meet their metadata management requirements.

QCIF offers ReDBox Lite as a fully hosted Managed Service, providing a cost-effective,
fuss free alternative to installing and maintaining your own infrastructure.
We can host ReDBox Lite on our
[QRIScloud infrastructure](https://www.qriscloud.org.au/)
or on public cloud infrastructure.

## Name authority and vocabulary service

The Mint is a name-authority and vocabulary service that complements ReDBox.
Expand Down
22 changes: 22 additions & 0 deletions features/configurable-forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,25 @@ excerpt: The flexible ReDBox form framework can adapt to organisation requiremen

## Custom Form Options

The flexible ReDBox form framework is designed to seamlessly adapt to the unique requirements of your organization.
Whether you need simple metadata capture or complex, multi-step workflows, ReDBox’s customizable forms provide a
versatile solution that empowers your data management processes.

### Key Features

- **Tailored Metadata Fields**: Create, modify, or remove fields to align with the specific data and
compliance needs of your institution.
- **Dynamic Field Controls**: Enable conditional logic to display fields based on previous user inputs,
streamlining the data entry process and reducing complexity for users.
- **Multi-step Forms**: Break down complex forms into manageable steps, ensuring clarity and
improving user experience without overwhelming researchers.
- **Predefined Templates**: Leverage predefined form templates
- **Integration-Friendly**: Easily integrate with other systems or data sources, pulling in or sending out
information to avoid redundant data entry and ensure streamlined workflows.
- **User Role Customization**: Assign specific form views and permissions to different user roles,
ensuring that each user sees only the fields that are relevant to their tasks and responsibilities.

ReDBox’s custom form options provide the flexibility and control you need to manage data in a way that
fits seamlessly with your existing workflows, all while ensuring compliance and ease of use.
Explore the power of custom forms with ReDBox and create tailored solutions that work for your
research data management needs.
108 changes: 47 additions & 61 deletions features/integration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,88 +8,74 @@ excerpt: ReDBox can seamlessly integrate with a range of institutional systems.
## Integration Options in ReDBox


This document outlines the various integration options available in the ReDBox platform.
ReDBox is designed to seamlessly integrate with a range of institutional systems, enabling
efficient data management and enhanced research workflows.

The integration options include a fully featured REST API, provisioner plugins for research
services, publishing integrations for disseminating data, and robust lookup data functionalities.
These integrations help ensure that ReDBox can be tailored to meet the specific needs of your
institution, fostering better data accuracy, streamlined processes, and improved collaboration
among researchers.
ReDBox integrates seamlessly with a variety of institutional systems, ensuring efficient data management and
streamlined research workflows.
These integration options include a fully featured REST API, provisioner plugins for research services,
publishing integrations for data dissemination, and powerful lookup data functionalities.
Each of these integrations helps ensure ReDBox can be tailored to meet the specific needs of your institution,
fostering data accuracy, smoother processes, and enhanced collaboration among researchers.

### REST API

ReDBox has a fully featured REST API that enables other systems to either modify information
within the platform or retrieve information from it. This API facilitates seamless integration
with various institutional systems, ensuring smooth data flow and interoperability.
ReDBox's fully featured REST API allows other systems to modify or retrieve information within the platform.
This ensures seamless integration with institutional systems, supporting smooth data flow and interoperability.

#### Common Use Cases

- **Exporting Data**: The export API can be utilized to retrieve data from ReDBox for integration
with an institutional data lake or reporting system. This ensures that data within ReDBox
can be consolidated with other institutional data for comprehensive analysis and reporting.
- **Triggering Record Creation**: The API can trigger the creation of a record in ReDBox based on
an action performed in another system. For example, an RDMP can be automatically created in
ReDBox when a project grant is approved in the Research Information Management System (RIMS).
This automation helps in maintaining data consistency and reducing manual effort.

### Provisioner Plugins

As part of ReDBox's workspace functionality, a variety of plugins are provided to provision
research services such as storage or other online tools. These plugins not only incentivize
researchers to complete their RDMPs but also help in linking the usage of these services to
specific projects. Several provisioner plugins are available for configuration:

- **ServiceNow**: Integrates with the [ServiceNow](https://www.servicenow.com/) platform to
create and manage service requests.
- **REDCap**: Facilitates the provisioning of [REDCap](https://www.project-redcap.org/) projects
and resources.
- **Terraform**: Automates the provisioning of infrastructure using
[Terraform](https://www.terraform.io/).
- **GitLab**: Manages [GitLab](https://about.gitlab.com/) repositories and resources.
- **OMERO**: Integrates with [OMERO](https://www.openmicroscopy.org/omero/) for
managing image data.
- **LabArchives**: Connects with [LabArchives](https://www.labarchives.com/) for managing
lab notebooks and research data.
- **Exporting Data**: Use the export API to retrieve data from ReDBox for integration with
data lakes or reporting systems, enabling comprehensive institutional analysis.
- **Automated Record Creation**: Trigger automatic record creation in ReDBox based on external system actions,
such as generating an RDMP when a project grant is approved in an external system.
This reduces manual effort and ensures data consistency.

### Provisioner Plugins for Research Services

ReDBox provides a range of plugins to provision research services like storage and online tools.
These plugins encourage RDMP completion and link service usage directly to projects, enhancing research workflows.

- **[ServiceNow](https://www.servicenow.com/)**: Seamlessly integrates for creating and managing service requests.
- **[REDCap](https://www.project-redcap.org/)**: Provision REDCap projects and resources.
- **[Terraform](https://www.terraform.io/)**: Automate infrastructure provisioning.
- **[GitLab](https://about.gitlab.com/)**: Manage GitLab repositories and resources.
- **[OMERO](https://www.openmicroscopy.org/omero/)**: Integrate with OMERO for image data management.
- **[LabArchives](https://www.labarchives.com/)**: Connect with LabArchives for managing lab notebooks and research data.

Additionally, many more plugins can be developed to extend the provisioning capabilities of
ReDBox, making it highly adaptable to various research needs and institutional requirements.

<img src="{{ '/static/images/provisioner.jpg' | relative_url }}"
class="img-fluid border rounded mx-auto d-block"
alt="Diagram showing provisioners and example data flow.">

### Publishing Integrations
{% capture figure_src_provisioner %}{{ '/static/images/provisioner.jpg' | relative_url }}{% endcapture %}
{% include figure_image.html
src=figure_src_provisioner
max-width="800px"
alt="Diagram showing provisioners and example data flow"
caption="Diagram showing provisioners and example data flow"
%}

ReDBox aids in the publishing of data by providing configurable workflows for review and
integration with [Datacite Fabrica's](https://doi.datacite.org/) API for DOI minting.
This facilitates the formal publication and dissemination of research data.
ReDBox also supports pushing records to institutional publication search and discovery portals.
The following portal systems are currently supported:
### Publishing and Dissemination

- **Figshare**: Integrates with [Figshare](https://figshare.com/) for publishing and managing
research outputs.
ReDBox simplifies data publishing with configurable workflows and supports pushing records to
institutional search and discovery portals, ensuring wide visibility for your research data.

- **[Datacite Fabrica](https://doi.datacite.org/)**: Integration with the Datacite Fabrica API for DOI minting
- **[Figshare](https://figshare.com/)**: Integrates with Figshare for publishing and managing research outputs.
- **OAI-PMH Feed**: Supports any portals that can ingest records using the OAI-PMH protocol,
such as [Research Data Australia](https://researchdata.edu.au/).

Additional portal systems can be integrated with further development, ensuring broad
compatibility with various publication platforms and maximizing the visibility and impact
of research data.

### Lookup Data
### Lookup Data Integration

ReDBox ensures accurate records with powerful lookup functionality for institutional information.
These lookup capabilities help maintain data integrity and streamline the process of filling
out records within ReDBox.

One of ReDBox's powerful features is its ability to provide lookup functionality for
institutional information, ensuring that records are filled out accurately. ReDBox supports
two primary methods for integrating lookup data:
- **API Integration**: Search and suggest values directly from source institutional systems in real time,
ensuring up-to-date information.
- **Ingesting Feeds**: Import data feeds from institutional systems and use internal search APIs to suggest
values for accurate data entry.

- **API Integration**: ReDBox can integrate with the APIs of source institutional systems, allowing
users to search and suggest values directly from these systems. This real-time integration
ensures that the most up-to-date information is available for record creation and management.
- **Ingesting Feeds**: ReDBox can ingest data feeds from source institutional systems using its REST
API. Once ingested, the internal search APIs can be used to suggest values to users,
facilitating accurate data entry and enhancing the overall user experience.

These lookup capabilities help maintain data integrity and streamline the process of filling
out records within ReDBox.

Loading

0 comments on commit 6c0f161

Please sign in to comment.