Research Output Profile

In this topic Hide

About this page

A research output profile allows you to define aspects of the data you are importing using the Research Outputs Feeder. It allows you to define the headers, the fields to use as categories, and map the source categories and fields to RME.

Menu path: RME > Integrations > Research Outputs Feeder Service > Research Output Profile

 

Process overview

The process to set up a profile for use in the Research Output Feeder Service involves the following key stages:

•        Create a file that replicates the exact headers for the columns of data you want to import from the source.

•        Create a new profile, uploading the file created in the previous stage.

•        Specify the column in the source file that contains categories and map these to RME categories.

•        Define mapping from source file column headers to RME fields.

•        Save the profile.

Also see: Research Outputs Feeder technical details

 

1. Prepare the Header file and categories

Create a file that replicates the exact headers for the columns of data you want to import from the source.
Format: CSV file or a tab delimited file, no bigger than 200 KB, with a minimum of 4 and a maximum of 100 columns. No naming restrictions.
Only the headers of this file are used in feeder configuration to specify the column that will contain categories in the source file in stage 2, and populate the list for field mapping in stage 4.

In preparation  for stage 3, you will also need to identify the exact categories from the source that you will enter for category mapping.

Example of header file and relationship to fields, as explained in the text

Click to view or hide: Example header file and relationship to mapping defined in the profile

2. Create a new profile

Set up a new profile on the Research Outputs Profile page by completing the following fields:

 Field Label

Description

Profile Name *

Mandatory

Distinctive name for the profile to easily identify it

•        Ideally, you create a profile for each source of research output data however you can have as many as you need.

•        The name must be unique; you cannot have two profiles of the same name.

•        The name must exactly match the folder name you set up in the network location for source files.

Column Headers *

Mandatory

Use this field to upload the file you created in step 1 with headings that match the source data you want to import.

It must be either a CSV file or a tab delimited file, up to 200 KB. If antivirus scanning is enabled in System Preferences, the file will only be uploaded if it passes the scan.

Once you save, you cannot upload a new file.

Tip: The name of the file will not be shown after loading so if you have a lot of different profiles, include the file name in the Description field below.

Try before saving

Before you save, you can upload a new file to add or change header information to match your source data.  Field changes are indicated on the Field Mapping tab by icons in the Status column. Once you save, you will not be able to change this header file.

For more about documents, see: Document upload and management and System Preferences, Linked Document Settings.

File Type

Read only

Type of file based on the file you uploaded

Category Column *

Mandatory

This dropdown is populated when you upload a Column Headers file. The first column of your file is selected by default.

Select the specific column header for the data that you want to use for category mapping, for example Document Type. You will need to enter the actual categories used in your source data in the Category Mapping tab below.

Description

Describe the profile to help distinguish it from others and add any special notes about what the profile is used for.

Tip: Note the name of the file you uploaded in the Column Header file field as a reference. The file name is not shown as it is not saved in the database; it's only used as a basis for configuration.
 

3. Map categories

In the Category Mapping tab, click Add and manually create the research output categories used in the source data, and then map them to the RME research output categories.
If you want to delete a category mapping, just click the cross X to the right of the line.

Field

Description

Source Category

Enter the source category manually

Important!

It must match exactly to the source data category or it may fail to import.

You can only use a Source Category once.

RME Category

Select the RME category to map to the source category

You can map two different source categories to a single RME research output category.

Format: eCode : Category Name : Year

Example:  A1: Books - Authored 2012 - 2023

Source: RME Research Outputs Categories including non-current

      The Year portion is sourced from the category configuration; it can show the range as From year - To year, or just one year if either From or To field is blank.

Status

Indicates if the recent field mapping could not be saved successfully

There is no auto-save when you enter details; validation processes run when details are saved.
You can go to the Field Mapping tab or other fields on the page, but do not click Close or leave the page or you risk losing your work.

 

4. Map fields

The Field Mapping tab automatically lists the column headings from the Column Headers file you uploaded for each source category. In the RME Fields column, manually map each one to an RME field, then click Save.  You need to map fields for each source category that you defined on the Category Mapping tab. The table below explains the mapping columns in this tab.

Time saver tip: When you save at least one source category and field mapping, you can copy or mirror field mapping using action buttons.

Field/Column

Description

Source Category

Select the source category for which you want to define the field mapping

Source: All source categories added in the Category Mapping tab on this page

Status

This is relevant if you upload a new Column Headers file. It compares the newly-uploaded file with the previous one and indicates the field status as follows:

•        (blank) = exists in both files so no change

•        A green plus icon + = new and will be added when you save

•        A red cross icon x = not in the new file and will be deleted when you save

Status icons disappear when you save.

Source Fields

The headers defined in the Column Header file that you map to RME fields

RME Fields

A popup list to select the RME field to map to the source field

Source: RME Research Outputs Page Views (PUB001)

Mandatory fields

You must always map the following RME fields:

•        Category Column; the header selected for the Category Column will be automatically mapped to * Category and is read-only

•        Collection Year

•        Title:

•        Books = Book Title

•        Journals = Journal Title or Journal Text Title

•        Conference = Conference Title or Conference Text Title

•        DOI or at least one ID field

 

There are a few types of fields you can select in this list:

Hyphen (-)

No mapping set

If you want to remove field mapping, use this option

Core

RME core fields

Special

Related items in RME:

Author - Populates the Contributors related item
You also need to define the following in the Configuration Data column:

•        Format of the name from the source, such as the default F, M, S
F = First name, M = Middle name and S = Surname

This tells the feeder what order the name segments are in from the source data file so it can extract them and add them to RME correctly.  You can use any combination of F, M and S to suit your source data.

Whatever combination of F, M and S that you use, make sure you use a separator between them. It can be a space, a dot (.) or a comma (,) but must be a different symbol to the author separator below.

Examples:

Source data name

Configuration

Will be shown in RME

Ronald, Eustace, Psmith

F, M, S

Ronald Eustace Psmith

Psmith Eustace Ronald

S M F

Ronald Eustace Psmith

Psmith, Ronald Eustace

S, F M

Ronald Eustace Psmith

Ronald E. P.

F M. S.

Ronald E P

 

•        Separator used in the source between names for multiple authors, such as the default comma (,) or a semi-colon (;) or a pipe (|).

This must be a different symbol to the format separator used for author names above.

DOI - populates the Document related item as a path

This is used in the matching algorithm. If the DOI already exists in the database, the record is not imported.

ID

ID fields, such as Magazine ID, Scopus ID or Symplectic ID

Format: Category group name + ID

Source: RME > Setup > Categories  > Source Types > Publication Source Types

 

Configuration Data

For some fields, additional information is needed and will display in this column, including:

•        Create if not existing option
If Yes, the system will check for any existing categories based on this particular field. If there is no matching category, it will create one. If you don't want new categories created, leave as No.

•        NAME/CODE dropdown
This displays for fields or categories that can have either a name or a code. You select which you prefer to use for mapping.
 

Action buttons

The table below explains the actio buttons in the Field Mapping tab.

Action button

Description

New

Define new mappings manually; it clears any previous mappings

Copy From

Copy the existing field mapping of a source category and edit to suit

Use the dropdown to select the category you want to copy.

This is only displayed when at least one source category field mapping has been saved.

Same As

Mirror the existing field mapping of a source category and reflect any future changes in both

Use the dropdown to select the category you want to mirror.

This is only displayed when at least one source category field mapping has been saved.
 

5. Save the profile

When you click Save, the details entered are validated. The Column Headers field is greyed out.

If there are any problems, notifications will display. For example, if mandatory fields were not mapped, a notification displays.

In the Category Mapping tab, if some fields were not successfully validated or saved, an exclamation icon is shown under Status for the impacted Source Category.

When a profile file is uploaded for this feeder, field-level details can be viewed from RME > System > Documentation > Feeder Service > Research Outputs Feeder (or customised name).

 

Edit an existing profile

If you want to change details for a research output profile that you have saved, click the profile entry in the grid on the Research Output Feeder Service page to display the details.

Be aware that if you make changes and saving the profile, previously saved changes will be removed and replaced with the latest profile version. If any import tasks are running at the time for that profile, data inconsistencies may result.

You can only change the following for a saved profile:

Action

Notes

Edit the profile description

 

Change or add a source category and mapping

Source Categories must match source data exactly or it may fail to import.

Change field mapping

Mandatory fields must always be mapped.

Change the column header defined in the Category Column

 Align the new header details with all mapping or it may fail to import.

For extensive changes, consider creating a new profile. If you no longer wish to use an old profile, delete it to avoid confusion.

 

Product Key: Feeder - Research Outputs

Page ID: FDR016.htm