The toolbar on this page offers options
that are relevant for the feature, such as Save.
Other options that are standard for other RME pages, such as New,
Next and Previous
are not relevant and are not displayed.
In this topic Hide
RME can be integrated with Symplectic Elements through the Symplectic API to feed publication and research output data harvested by Symplectic Elements into the RME Research Outputs module for management purposes. The RME Symplectic Service needs to be configured and then scheduled to run on a server for the Symplectic integration to be active.
Knowledge required: Understanding of Symplectic Elements and RME experience of the Research Outputs module
Details are provided in the RME Symplectic Service Guide in the RME release package if you have this product key.
The toolbar on this page offers options
that are relevant for the feature, such as Save.
Other options that are standard for other RME pages, such as New,
Next and Previous
are not relevant and are not displayed.
Menu path: RME > Integrations > Symplectic Service
To set up and run the RME Symplectic Service, the following tasks need to be performed in the order specified below:
1. Set up research output categories for each Symplectic Elements publication type you wish to import. The RME Symplectic Service will only import publications when the type has been mapped to a research output category. If you want to allow the maximum number of publication records to be imported, you can relax the validation rules when configuring each research category. See: Research Output Categories
2. Configure the RME Symplectic Service in RME as specified below in each section.
3. Schedule the RME Symplectic Service to run periodically as a scheduled Windows task created using the RME Symplectic utility. You may need to request assistance from your IT department. For steps, refer to the RME Symplectic Service User Guide provided in the RME release package.
You use the fields in this section to define the connection details to establish a link to Symplectic Elements:
Field |
Description |
Symplectic Service URL |
URL of the Symplectic Elements API |
Symplectic Service Username |
Symplectic Elements API username |
Symplectic Service Password |
Symplectic Elements API password |
Test Connection |
Checks the connection with Symplectic Elements API If connection is successfully established, the Preferred Source Configuration list will be populated from Symplectic Elements. If not successful, a message will display. |
Refresh Data |
Updates the data from Symplectic Elements in the following sections of this configuration page: • Preferred Source Configuration in the Symplectic Preferred Publication Source field, in the Available Source column • Category Mapping in the Symplectic Category column If an item row was displayed previously but is no longer visible after refreshing, the item was not included in the updated Symplectic data and has therefore been removed. |
Users in Symplectic Elements and Personnel in RME are managed separately in their own system. However, for your institution, they may be sourced from the same HR system. In order to identify the publications that belong to your RME users, the system needs to first match the Symplectic user to an RME person. You can select the matching rules that are used to identify the same user in the two systems. The matching rules provided try to use all the possible user information available in Symplectic Elements (from both “User” and “Publication Authors”) to find a match to a unique RME Personnel data field.
To select which rules you want to apply, tick or untick the checkbox next to each. The user is considered to be matched between the two systems whenever a match is found using any of the selected matching rules.
Checkbox option |
Symplectic element |
RME |
User 'PROPRIETARY-ID' => Person 'ECODE' |
PROPRIETARY-ID element of User object |
ECODE field of the Personnel record |
User 'PROPRIETARY-ID' => Person 'STUDENTID' |
PROPRIETARY-ID element of User object |
STUDENTID field of the Personnel record |
User 'EMAIL-ADDRESS' => Person 'EMAIL-ADDRESS' |
EMAIL-ADDRESS element of User object |
EMAIL-ADDRESS field of the Personnel record |
User 'PROPRIETARY-ID' => Person 'STAFFID' |
PROPRIETARY-ID element of User object |
STAFFID field of the Personnel record |
Author 'EMAIL-ADDRESS' => Person 'EMAIL-ADDRESS' |
EMAIL-ADDRESS element of Author object |
EMAIL-ADDRESS field of the Personnel record |
To import FoR code classifications associated with each Symplectic publication,
enable the Import FOR codes from Symplectic
option (Yes). Both FOR codes and
their percentages will be imported to the RME Research Output Classification
related item for each record that is imported.
Use the following options to enable or disable the update and delete policies for the RME Symplectic Service:
Option |
Setting |
Description |
Enable Update Mode for Symplectic Service? |
Yes |
For any updated Symplectic Element publication that was previously imported, the corresponding RME Research Output record will be updated, provided it is not marked as Verified at any level in RME |
No |
Previously imported records will be ignored |
|
Enable Delete Mode for Symplectic Service? |
Yes |
For any deleted Symplectic Element publication that was previously imported, the corresponding RME Research Output record will be removed, provided it is not marked as Verified at any level in RME |
No |
Previously imported records will be ignored |
A publication is considered "updated"
if it has been modified in Symplectic Elements since it was last successfully
imported by the RME Symplectic Service, including changes to the publication
data, authorship or to the user profile of an author.
This section allows you to control the publications imported into RME, as follows:
Option |
Description |
Symplectic Preferred Publication Source |
Symplectic publications can be harvested from multiple sources. When importing Symplectic publications into RME, you can select the sources in order of your institution's preference. The publications will then be imported from the first found source in the ordered list during the import process The available sources are retrieved dynamically from the Symplectic API and are populated when there is a successful connection to the Symplectic API, as tested in the Connection Configuration section above. |
Symplectic Record Filter (XPath) |
If you want to control the publications that can be imported into RME, you can set a “filter” by specifying an XPath in this field. When applied, this filter will import publications that match the defined XPath as well as publication data that has been set with other applicable business rules. You can define the selection rule using data available in the Symplectic API or by using a custom field in Symplectic. The filter will search through the source XML for elements that match the configured XPath. This filter is only used to check if the publication record can be imported, while the data source to be imported still follows the precedence set in the configuration. If the XPath filter is not specified and the field is left blank, it will not be used. All publications marked as Verified will be imported. For details and an example filter, refer to the RME Symplectic Service User Guide provided in the RME release package. |
All publications in Symplectic Elements are associated with a publication type. It is used in a similar way to the RME research output category .
Before you started configuring the RME Symplectic Service, you would have defined a research output category to map to each Symplectic publication type you want to import, as outlined in the tasks section above. The RME Symplectic Service will only import publications when the publication type has been mapped to a research output category.
Be aware that every Symplectic publication record must meet the data
requirements set in the RME research output category settings for it to
be imported successfully. For example, if the Title
field is marked as Required in
the RME research output category configuration, any Symplectic publication
without a Title will be rejected
during import. This is a powerful tool to ensure that only valid publication
data is imported into the RME Research Output module.
The service needs to be run periodically as a scheduled Windows task created using the RME Symplectic utility. Your IT department should be able to assist with this task.
The Import Results tab provides a summary report of scheduled runs of the RME Symplectic Service and includes the following information:
Column |
Description |
Started |
Date the Symplectic service began If you export the data from the grid, the time stamp will also be included in the data. |
Completed |
Date the Symplectic service finished If you export the data from the grid, the time stamp will also be included in the data. |
Successful |
Number of records successfully imported, including both newly created and updated |
Ignored |
Number of records ignored out of the eligible records during the import process |
Failed |
Number of records not imported out of the eligible records during the import process |
Log Message |
A brief message when something has gone wrong Log messages may not be displayed in full due to a screen size limitation, however you can export the data via the Export option to see the full message. |
For full details of a scheduled run, click
the link in the Started column of the row for the run. See: Import
Result
Research outputs imported from Symplectic Elements can be viewed immediately from RME Research Output module. You can use the following sample filter criteria in the Advanced search section to search for research output imported from Symplectic Elements:
|
Area |
Search On |
Operator |
Value |
Including |
Research Outputs |
Category |
Equal To |
Symplectic Import - [type, such as Book authored, Book Chapter, Journal Article, Conference Paper, depending on what is configured for your institution] |
Product Key: Interface - Symplectic
Page ID: FDR001.htm