There is no template to download for
the Research Outputs feeder so the Download
Template(s) button is disabled for this feeder.In this topic Hide
This page enables administrators and IT specialists to search for and view low-level data for the RME Web API, eForm domains and feeder services, such as field lists.
Tabs provide details for each feature. The tab for Web API Routes is displayed by default.
You can click the Open icon next to items in the grids to drill down for more information. For a full breakdown of the information available at the various levels, see: Documentation structure
Menu path: RME > System > Documentation
This tab lists all routes available for the RME Web API based on what is licensed for your institution.
Note: Documentation for the RME API - Read only is not included in this page. For that API, documentation is automatically generated by the API itself. Refer to the APIs for RME document for details.
Details and field data drill down
To view field level data and the mapped page name for a web API route, click the Open icon next to it in the grid. See: Web API Routes
Export
To export the Web API route grid details, click the Export button on the toolbar.
To export all available Web API routes and field data, click the Export All Routes & Fields button on the toolbar.
Web API Routes grid
For each route, the grid in this page contains the following information:
Column |
Description |
Can Create? |
Whether you can perform the Create (POST method) on the resource or resource collections |
Can Delete? |
Whether you can perform the Delete (DELETE method) on the resource or resource collections |
Can Read? |
Whether you can perform the Read (GET method) on the resource or resource collections |
Can Update? |
Whether you can perform the Update (PUT method) on the resource or resource collections |
Location |
Where the API is located For example, for the AOU API the location would be: api/AOU({core_id})/Link({id}) |
Name |
Name of the API route |
Page ID |
ID for the RME page/s on which the record is displayed For the corresponding page description, click the Open icon next to it in the grid to display field level data. |
Version |
RME version in which the Web API route was introduced |
This tab lists all domain fields and related item controls for each domain, and Ethics or HDRCM template category, based on what is licensed for your institution.
Details and field data drill down: To view field and related item control level data, click the Open icon next to it in the grid. See: eForm Domains
Export: To export the eForm Domains grid details, click the Export button on the toolbar.
eForm Domains grid
For each domain or Ethics/HDRCM template category, the grid contains the following information:
Column |
Description |
Category |
Template category for specific eForm domains This is only relevant for Ethics and HDRCM domains, which each have a range of purpose-built template categories. For other domains, the domain name is repeated. |
Domain |
Code for the domain |
Domain Name |
What the domain is called |
Page ID |
Identifier for the page for the domain or Ethics/HDRCM template category Page IDs are not always Page Views; for eForms, the ID is a more of a technical identifier. |
This tab lists all RME feeders, their specific data feed details, and the pages mapped for each data feed. RME feeder services are provided for Finance, HR, Research Outputs (formerly called Publications) and Student. You can also select a feeder in the grid and download the template that defines the headers you need to use and the order of items.
Details and field data drill down
To view field level data for a data feed, click the Open icon next to it in the grid.. For more, see: Feeder Service.
Download a template
To download a template that provides the defined headers and order of items for the Finance, HR and Student feeders, follow these steps:
1. In the Feeder Service grid, select one or more feeders by clicking the checkbox to the left of each so it is ticked.
2. In the toolbar, click the Download Template(s) button.
3. Allow the download, if a prompt displays. Each template will open or be saved as a .csv file.
For details about using these templates and running feeders, refer to the relevant PDF feeder documentation provided in your RME build package. Some basic information is also provided on the feeder help pages: Finance, HR, and Student.
There is no template to download for
the Research Outputs feeder so the Download
Template(s) button is disabled for this feeder.
Export
To export the Feeder Service grid details, click the Export button on the toolbar.
Feeder Service grid
For each feeder service, the grid contains the following information:
Column |
Description |
CSV File Name |
Template for the data feed |
Data Feed |
Data feed in the feeder for a specific purpose |
Feeder |
Name of the data feeder |
Page ID |
ID of the RME page the data is fed into for the data feed |
In the Documentation pages, you can drill down for more details. The tables below list the information available at each level for each tab as a guide.
Web API Routes
Type of information |
Drill down level |
How to view it |
Details in the page |
Web API route list |
1 |
RME menu > System > Documentation > Web API Routes tab |
Route grid: Can Create, Can Delete, Can Read, Can Update, Location, Name (link), Page ID(s), Version Scroll to other routes with Previous and Next buttons. |
Route details |
2 |
Select a Name in level 1 route grid |
Route fields: As above plus Description, and Page Name (for mapping) |
Available fields for a route |
2 |
Select a Name in level 1 route grid |
Field grid: API Reference, Category Group, Data Type, Description, Field Name (link), Is Read Only?, Is Required?, Max Length |
Field details |
3 |
Select a Field Name in level 2 Field grid |
Field popup: As above plus Page Field and Page Field Description (for mapping) |
eForm Domains
Type of information |
Drill down level |
How to view it |
Details in the page |
eForm domain list |
1 |
RME > System > Documentation > eForm Domains tab |
Domain grid: Category, Domain (link), Domain Name, Page ID(s) Scroll to other domains with Previous and Next buttons. |
Domain and fields |
|||
Domain details |
2 |
Select a Domain in level 1 domain grid |
Domain fields: As above plus Description |
Fields for the domain /category |
3 |
Select a Domain in level 1 Domain grid, select the Fields tab |
Fields grid: Category Group, Data Type, Description, Field Name (link), Label Name, Max Length |
Field details |
4 |
Select a Field Name in level 3 Fields grid |
Field popup: As above plus Is Read only?, Is Required?, Response Type Scroll to other fields with Previous and Next buttons. |
Related Item Controls |
|||
Related Item Controls for the domain/ category |
2 |
From a selected Domain in level 2, click the Related Item Controls tab |
Related Item Controls grid: Description, Is Read Only?, Page ID, Name (link) |
Related item control fields |
3 |
Select a Name in level 2 Related Item Controls tab |
Fields grid: Category Group, Data Type, Description, Field Name, Label Name, Max Length |
Related item control field details |
4 |
Select a Field Name in level 3 Fields grid |
Field popup: Category Group, Data Type, Description, Field Name (link), Is Read Only?, Is Required?, Label Name, Max Length, Response Type Scroll to other fields with Previous and Next buttons. |
Feeder Service
You can view details about a data feed down to the field level outlined in the table below.
Type of information |
Drill down level |
How to view it |
Details in the page |
Feeder service and data feed list |
1 |
RME menu > System > Documentation > Feeder Service tab |
Feeder Service grid: CSV File Name, Data Feed, Feeder (link), Page ID Scroll to other data feeds with Previous and Next buttons. |
Available fields for a data feed |
2 |
Select a Feeder in a level 1 feeder service grid |
Field grid: Data Type, Description, Field Name (default link), Label Name, Max Length, Order |
Field details |
3 |
Select a Field Name in a level 2 Field grid |
Field popup: As above plus Category Group, Comments, Is Required?, Validations Scroll to other fields with Previous and Next buttons. |
• Some pages take a while to load if there are a lot of items, so you may need to wait the first time you click a tab.
• For eForms, no details are provided for Custom RICs because you create these as needed in RME Designer; the details are unknown.
• For HDRCM, the Examiner Outcome template category does not have any RICs so this page is blank.
• If you find that a page is not loading items that you expect, there may be a system cache issue. Ask your IT team to reset the environment, for example, IIS reset. This is likely to fix any system cache discrepancies.
Product Key: Modules - Core
Page ID: DOC001.htm