Product Key

In this topic Hide

This page provides information about the product keys applied for your current RME licence, and allows you to apply a new product key. It was formerly called "RME Licence".

An expiry date is shown at the top of the page. Example: Purchased product/s expire 31/12/2099 11:59:59 PM

Your RME license determines the RME components your institution has purchased and the number of users you can have.

Menu path: RME > System > Product Key

Install a product key

For a fresh installation, you will need to install product keys. For an upgrade, product key information is generally retained in the database.

If you have been given a new RME product key with the extension of .pkey and an extended product key with the extension of .lic, install both of them.

To install an RME product key, follow these steps:

1.     Go to RME > System >  Product Key (formerly "RME Licence").

2.     In the Upload Product Key field, click Select file. You can also drag and drop the file to this field, in which case skip ahead to step 4.

3.     Select the product key file with the extension ".pkey" or ".lic" provided to you.

4.     Select Save to install the key.

5.     If you installed a file with the extension ".pkey" and you also have a product key file with the extension ".lic", repeat the above steps to install that.

6.     Restart all RME web services, for example, by IISRESET, to activate the product key. For an update, this will apply product key changes. If there is an error, a message will display.

Product key descriptions

The following tables provide descriptions of product keys for each group, listed in alphabetical order:

API

Product Key

(in alphabetical order)

Description

RME API - Read only

Allows administrators to perform operations on data resources (currently GET only) within the RME system via an OData API that exposes business data, including eForm application data, read directly from the data warehouse.

All fields that can be used are visible in the API interface. System, configuration and audit data is not available by design.

RME eForms API

Allows administrators to retrieve eForm application details from any domain to use in another system (READ/GET only).

In some special cases, it can be used to create eForms. This is only available for:

1        RME Enrolment and Scholarship applications
This xml-based API can be used to configure third-party systems to interact securely with the RME system to create eForm applications based on the Enrolment and Scholarship eForm template category.

2        ARC Grants
This feature leverages the RME eForms API to enable import of ARC grant data into RME  Research Project Request (RPR) eForm applications. Both this product key and the ARC Grants product key must be applied.
References: ARC Grants, and the RME ARC Grants Integration Guide

RME Web API - Core

Allows administrators to integrate RME with other systems via a REST-based Web API that includes core objects required as a prerequisite for other API modules, such as categories, classifications, AOUs, and organisations

RME Web API - Contracts

Allows administrators to integrate RME with other systems via a REST-based Web API that includes objects relating to Contract records

RME Web API - Ethics

Allows administrators to integrate RME with other systems via a REST-based Web API that includes objects relating to Ethics records

RME Web API - Personnel

Allows administrators to integrate RME with other systems via a REST-based Web API that includes objects relating to Personnel records, such as user, role, person, address, and person contact details

RME Web API - Project Finance

Allows administrators to integrate RME with other systems via a REST-based Web API that includes objects relating to project finance, such as account code, fund scheme, fund scheme, project budget, and project transactions

RME Web API - Research Outputs

Allows administrators to integrate RME with other systems via a REST-based Web API that includes objects relating to research outputs, such as publications, books and journals

RME Web API - Student

Allows administrators to integrate RME with other systems via a REST-based Web API that includes objects relating to student details, such as student type, address, contact details, AOU and campus

Reference documentation: APIs for ResearchMaster Enterprise (RME) and in RME, field-level details in RME > System > Documentation - Web Routes


Dashboard widgets

Dashboards are a collection of dynamic and personalised widgets that provide at-a-glance views of different information relevant to you on the RME Home page.

Administrators can create dashboards and set defaults for different RME roles, as well as set permissions for dashboard management.

Product Key

(in alphabetical order)

Description

AOU Performance Summary

Designed for staff from an organisational unit, it shows a summary of an org. unit's funding to provide an at-a-glance view of performance

See: Org. Unit Performance Summary

Application List

Lists the eForms that a user can open for a defined tab on the eForm listing page

See: Application List

Calendar

Displays important events, such as Significant Events (deadlines, milestones, tasks or invoice tasks) as well as committee meetings for committee members

Supervisors can see events for students they supervise.

See: Calendar including a video

eForm Templates

Allows users to create a new eForm for the defined domain

See: eForm Templates

Global Notices

Designed for general communications to all RME users at your institution

See: Global Notices

Researcher Notices

Designed for general communications to all researchers at your institution

See: Researcher Notices

Researcher Performance Chart

Displays a bar chart for a year range and option/s, can be a mix of Projects, Research Outputs and Supervision

See: Researcher Performance Chart

Researcher Performance Details

Displays summarised information for the selected year and option, either Projects, Research Outputs or Supervision (only one option at a time)

See: Researcher Performance Details

Significant Events

Enables office staff or  researchers to view high level information about Project and Contract Significant Events involved in research project invoicing

See: Significant Events

Student Course Completion Summary

Designed for HDR administrators, this provides details for all current students close to completing a course, or overdue, filtered by the administrator's data access security, to allow administrators to plan course completion activities

See: Student Course Completion Summary

Student Details

Allows HDR Students to view their own general details in the RME Home page

See: Student Details

Student Leave Details

Allows HDR students to manage their leave

See: Student Leave Details

Student Notices

Designed for general communications to all students at your institution

See: Student Notices

Student Progress

Gives HDR students the ability to view their own course progress as a graph, drawn from the HDR Student module

See: Student Progress

Supervision

Gives supervisors the ability to view the progress of students they are supervising by a series of graphs, one per student, drawn from the HDR Student module

See: Supervisor

References: Dashboard and Dashboard widgets


eForms

Product keys for eForms generally provide the eForm functionality for a functional area, or domain, which maps to a core module. For example Research Project Requests (RPR) maps to the Project module.

The Ethics and HDRCM domains have an additional template category that is used to create certain types of eForm templates. Most template categories are available by license so they have separate product keys.

Product Key

(in alphabetical order)

Description

Contracts

Provides eForm functionality for contracts, including:

        RME Designer access to create eForm templates, workflows and reports for this domain

        Contracts eForm listing page in RME (with search function for administrators)

        Contracts eForm administrative actions in RME

Ethics Animal

Provides eForm functionality for ethics eForm applications based on the Animal Ethics template category including:

        RME Designer access to create Ethics eForm templates, workflows and reports

        Related Item Types to create Related Item Controls (RICs) for animal ethics

        Ethics eForm listing page in RME (with search function for administrators)

        Ethics eForm administrative actions in RME

        Committee Meeting management pages, including the ability to link eForm applications to a committee meeting from the Ethics eForm listing page

Ethics Biosafety

Provides eForm functionality for Ethics eForm applications based on the Biosafety template category including:

        RME Designer access to create Ethics eForm templates, workflows and reports

        Related Item Types to create Related Item Controls (RICs) for biosafety ethics

        Ethics eForm listing page in RME (with search function for administrators)

        Ethics eForm administrative actions in RME

        Committee Meeting management pages, including the ability to link eForm applications to a committee meeting from the Ethics eForm listing page

Ethics Human

Provides eForm functionality for ethics applications, based on the Human Ethics template category including:

        RME Designer access to create Ethics eForm templates, workflows and reports

        Related Item Types to create Related Item Controls (RICs) for human ethics

        Ethics eForm listing page in RME (with search function for administrators)

        Ethics eForm administrative actions in RME

        Committee Meeting management pages, including the ability to link eForm applications to a committee meeting from the Ethics eForm listing page

HDR Change of Study Mode

As an addition to the HDRCM domain key, this provides the Change of Study Mode template category to create eForm templates to handle study mode change applications online, for example from full-time to part-time.

HDR Course Extension

As an addition to the HDRCM domain key, this provides the Course Extension template category to create eForm templates to process applications for course extensions

HDR Enrolment & Scholarship Application

As an addition to the HDRCM domain key, this provides the Enrolment and Scholarship Application template category to create eForm templates to process prospective student eForm applications for a new course and/or scholarship

With the RME eForms API, eForm applications based on this template category can be created with data from third-party systems.

HDR General (HDRCM)

Provides eForm functionality for HDRCM student applications, including:

        RME Designer access to create eForm templates with the General template category, workflows and reports for the HDRCM domain

        Manage HDR eForms (HDRCM) listing page in RME (with search function for administrators)

        HDRCM eForm administrative actions in RME

HDR Leave

As an addition to the HDRCM domain key, this provides the Leave template category to create eForm templates to specifically handle leave applications

HDR Progress Review

Provides eForm functionality for HDR student progress reviews (HDR PR), including:

        RME Designer access to create eForm templates, workflows and reports for this domain

        Manage Progress Reviews eForm listing page in RME (with search function for administrators)

        HDR PR eForm administrative actions in RME

HDR Research Study Plan

As an addition to the HDRCM domain key, this provides the Research Study Plan and Review template category to create eForm templates to record and optionally approve study plans for researchers and for subsequent progress reviews via separate, linked eForms to share information to avoid duplicated data entry

eForm templates can be configured to automatically link to Significant Events for progress review handling.

HDR Submission and Examination

As an addition to the HDRCM domain key, this provides the Submission and Examination and Examiner Outcome template categories to create eForm templates for examination activities for a student’s enrolment, such as thesis submission, entering examiner outcomes in automatically-created child eForms per examiner, and entering an overall exam result

HDR Supervisor Registration

As an addition to the HDRCM domain key, this provides the Supervisor Registration template category to create eForm templates to process applications relating to supervisors: to either register as a new supervisor, renew existing supervisor registration, or upgrade a supervisory level, or deregister (each form can only be for one of these purposes)

HDR Nominations

As an addition to the HDRCM domain key, this provides the Nominations template category to create eForm templates for different types of nominations, for either examiners, supervisors or progress panel members

Research Outputs

Provides eForm functionality for research outputs, including:

        RME Designer access to create eForm templates, workflows and reports for this domain

        Research Outputs eForm listing page in RME (with search function for administrators)

        Research Outputs administrative actions in RME

Research Project Requests (RPR)

Provides eForm functionality for research project or grants, including:

        RME Designer access to create eForm templates, workflows and reports for this domain

        Research Project Requests eForm listing page in RME (with search function for administrators)

        RPR eForm administrative actions in RME

Reference documents: RME eForm Administrators Guide, RME eForm Designer User Guide, and RME Workflow Designer User Guide


Feeder

RME feeders are designed to feed data from other systems into RME at regular intervals so that RME always has the most up-to-date data.  Feeders are run as Windows scheduled tasks using the RME Feeder Service utility.

Product Key

(in alphabetical order)

Description

HR

Allows administrators to import personnel data from a Human Resources (HR) system to RME

See: HR Feeder

Project Finance

Allows administrators to import the transactions financial data from a Finance system into the RME Projects module, Transaction Financials related item

See: Finance Feeder

Research Outputs

Allows administrators to import data for publications and other outputs from research from external source systems into RME

You can import publications data such as books, journal articles or conference proceedings from various sources, such as Scopus, ePrint and so on.

See: Research Outputs Feeder

Student

Allows administrators to import student data from an external Student system into RME

See: Student Feeder

Technical reference documents: RME HR Feeder Guide, RME Finance Feeder Guide, RME Research Outputs Feeder Guide, and RME Student Feeder Guide


Interface

The following interface components allow administrators with technical knowledge to import into RME or export data out to other third-party systems:

Product Key

(in alphabetical order)

Description

ARC Grants

The RME eForms API product key must also be applied for this feature

Allows administrators to extract data from the ARC for the institution’s researchers via the ARC API to import data for new grants not previously recorded in RME into Research Project Request (RPR) eForm applications

References: ARC Grants, and RME ARC Grants Import Integration Guide

NHMRC Grants

Allows administrators to import NHMRC files, such as data for grant applications, project investigators and project budgets for a given funding round

See: NHMRC Grant Import

Symplectic

Allows administrators to integrate RME with Symplectic Elements through the Symplectic API, to retrieve eligible research output data from Symplectic Elements and import into the RME Research Outputs module

See: Symplectic Service

Technical reference document: RME Symplectic Service Guide

TRIM

Allows administrators to export eForms and related documents into Micro Focus Content Manager, formerly known as TRIM or HP Content Manager

See: TRIM integration


Modules

The RME web interface provides web pages that allow the users to interact and manage research data, grouped into modules as defined areas of functionality and purpose.

The following product keys are available for RME modules and components:

Product Key

(in alphabetical order)

Description

Application Trigger

Provides a system component that allows IT specialists with JavaScript knowledge to define scripting rules that will automatically create or update Significant Events based on changes or updates to fields in RME core, related item or eForm, including:

        Application Trigger

        Page View to allocate user access

Contracts

Provides core functionality to record information about the terms and conditions of contracts or agreements associated with research project-based work, or any type of commercial activity that your institution, your organisational units or staff are engaged in, including:

        Contracts search page

        Contract record and related item pages

        Clause Definition and Clause Set pages

        Administrator actions for relevant Contract pages

        Reports for the module, if available (as designed in RME Designer)

        Page Views to allocate user access

        Specific global label preferences

Core

Base functionality for the RME application as a whole, including all system and set up pages to configure the system, and user management

Costing and Pricing Tool

Called "CPT" for short, provides the functionality to capture project costs, and calculate the overall cost and price of projects based on defined funding guidelines in order to help researchers seek project approval and apply for funding using eForms, including:

        Configuration pages in RME for funding rules and salary rates

        CPT pages accessed from a Project record or eForm, as configured, including costing and pricing outputs

        Page Views to allocate user access

        Specific global label preferences

        Integration of CPT data with RME and eForms

See: Costing and Pricing Tool overview

ERA Assist

A tool that provides the functionality in the Research Outputs module to help institutions collect and collate data for Excellence in Research for Australia (ERA) submission, including:

        ERA Assist configuration pages in RME

        ERA Assist tool

        Page Views to allocate user access

        Specific global label preferences

Ethics

Provides core functionality to collect and maintain information relating to ethics applications and approvals, and ethics clearance, including:

        Ethics search page

        Ethics record and related item pages

        Species record pages

        Ethics configuration in System Preferences

        Ethics Categories pages

        Administrator actions for relevant Ethics pages

        Reports for the module, if available (system reports or as designed in RME Designer)

        Page Views to allocate user access

        Specific global label preferences

External User Registration

Provides a system component that allows administrators to provide access to people that do not exist in the system, such as external researchers, students, supervisors or examiners, including:

        In System Preferences:

        ­External Users Preferences tab

        ­Password Preferences tab

        External User Search and External User pages in RME

        Page Views to allocate user access

Reference: External User overview

Finance Significant Events

Provides additional functionality system-wide to support financial activities (invoices, acquittal, deliverables, journal entries)

This solution includes:

        Additional fields and sections in Contract Significant Events and Project Significant Events

        Additional fields and sections in the Significant Events RIC in Contract and Research Project Request (RPR) domains

        A dedicated Significant Events widget

        Use of the Project record, Cost Centre related item

HDR Candidates

Provides core functionality to record information about Higher Degree Research (HDR) students, courses, subjects, including:

        Students search page

        Student record and related item pages (includes study load calculation)

        Course and Subject record pages

        HDR configuration page

        Administrator actions for relevant HDR pages

        Reports for the module, if available (system reports or as designed in RME Designer)

        Page Views to allocate user access

        Specific global label preferences

Page Layout Designer

Provides a system component that allows customisation of the layout of a Page View as well as field properties, such as labels, including:

        Page Layout Designer for core pages; not available in pages for eForms, system configuration, Costing and Pricing Tool, ERA Assist

        Ethics Category Layout Designer

        Research Output Category Layout Designer

Projects

Provides core functionality to collect and maintain information about research projects, including project or grant applications, including:

        Projects search page

        Project record and related item pages

        Project configuration in System Preferences

        Administrator actions for relevant Project pages

        Reports for the module, if available (system reports or as designed in RME Designer)

        Page Views to allocate user access

        Specific global label preferences

Research Costing and Pricing

Called "ReCaP" for short, this is a precursor to the more recent Costing and Pricing Tool

It is a component that integrates with the RME web application to capture project costs, and calculate the overall cost and price of projects based on defined funding guidelines.

See: Research Costing and Pricing (ReCaP)

Research Outputs

Provides core functionality to capture and manage details about the publications and other outcomes from research, such as journal articles, conference papers or book chapters through to creative works, patents, designs and other type of peer esteem measures and awards, including:

        Research Outputs search page

        Research Outputs record and related item pages

        Books, Conferences, Journals and Publishers record pages

        Research Outputs configuration in System Preferences

        Research Outputs Categories pages

        Administrator actions for relevant Research Output pages

        Reports for the module, if available (system reports or as designed in RME Designer)

        Page Views to allocate user access

        Specific global label preferences

RM Public Portal

A stand-alone website that can be used by members of the public to search for and view researcher profiles

While completely separate to the RME system, it sources defined details from the RME database.

Researchers and/or RME administrators can control whether to share details in the portal via settings in RME records for Personnel or Student, Projects and Research Outputs, or via an eForm.

See: Public Portal

Scholarship Management and Payments Tool

Enables HDR/Scholarship administrators to create and manage a wide range of scholarship and funding details, such as scholarship funding rules, eligibility criteria, and payments

eForm functionality allows HDR students to search for and apply for scholarships online. Application eForms can then be routed online for review and processing.

See: Scholarship Management and Payments Tool


Product Key: Modules - Core

Page ID: SYS002.htm