Feeder Service

In this topic Hide

About this page

This page displays details about a data feed for a feeder service that was selected on the Documentation page. RME feeder services are provided for Finance, HR, Research Outputs (formerly called Publications) and Student.

To scroll through data feed details, click the Previous or Next buttons at the top.

To drill down to field level information, click the Open icon next to it in the grid. Selected fields display in a grid. To export the grid details, click Export at the top, right of the grid.

To view the details of a field, click the Open icon next to it in the grid. A popup displays the details, including any relevant category group, if the field is mandatory, validation notes and comments. To scroll through other fields for the selected data feed, click the Previous or Next buttons in the popup.

Menu path: RME > System > Documentation > Feeder Service tab

 

Fields tab: Fields

Feeder data feeds display  the following read-only information for fields:

Column

Description

Category group

Only displayed for a selected field, not displayed in the data feed grid

Category linked to the field

Categories are managed in RME > Setup > Categories.

Comments

Only displayed for a selected field, not displayed in the data feed grid

Additional information about the field

Data Type

Format of the field, from the following options:

Data Type

Description

BOOLEAN

Value that is either Yes (True) or No (False)

See: Values for Boolean fields

DATE

Date and, if relevant,  time value

Range: Between midnight on the 1st January 0001 and just before midnight on December 31, 9999

NCLOB

Multiline text data

NUMBER

Digit or sequence of digits

NVARCHAR2

Sequence of characters with a defined length; text data

 

Field Name

Name for the field used in the back-end of the application

In the grid, click this to view the field details.

Note! For the Finance Feeder, a Type field was added to the Finance Feeder in v7.7.0 but is not fully supported. The value is hard-coded as the default value, Finance Category, which supports legacy feeder integrations. If you want to use this field to interface RME with external systems, use an RME API instead.

Is Required?

Only displayed for a selected field, not displayed in the data feed grid

Whether the field is mandatory

Label Name

Label for the field as displayed in the RME page

Max Length

Total number of characters that can be inserted into the field

Order

Order of the field in the associated template

Validations

Only displayed for a selected field, not displayed in the data feed grid

Expected values, format or business rules, for example, "Must be a unique ID"

 

Values for Boolean fields (Yes, No)

If any fields require a Yes or No (True, False) answer, such as checkboxes, feeders can handle the following values (not case sensitive): yes/no, 1/0, y/n, true/false, t/f, on/off. 

All values are translated into 1/0 in the RME database.

 

Run a feeder service

For full details about running a feeder service, 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, Student, and  Research Outputs.

 

Product Key: Modules - Core

Page ID: DOC007.htm