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 TRIM integration can be used to export eForm documents into Micro Focus Content Manager, formerly known as TRIM or HP Content Manager. To align with common terminology used to refer to this system, "TRIM" will be used in the user interface and documentation.
The integration status and TRIM record number can be displayed in an eForm.
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 > TRIM
• To use this feature successfully, you should have knowledge of XML and Windows scheduler.
• You must include the Schedule for TRIM workflow activity in RME Designer in the workflow associated to eForms, which is available in all domains. For more about workflow activities, refer to the RME Workflow Designer User Guide.
• To include TRIM information in an eForm, you must include the Title field (HTML_TITLE). You can add a read-only field for TRIM Integration Status and an editable TRIM Id to an eForm template in all domains, except HDR PR.
• The TRIM Integration Status field automatically reflects the status of TRIM integration processing, as either Scheduled (not yet processed), or Processed. If there was a problem processing the details, the status will be Failed. Exceptions will be listed in the Export Results page and log for further investigation.
• The Trim Id field can be completed if it is blank in the form, or modified if it is pre-populated with an existing ID. A newly-entered or modified ID will be validated against Trim. If not valid, error messages will display. If the Trim Id field is left blank with no value entered or modified in an eForm, when the Schedule for TRIM workflow activity is executed, a new Trim record will be created, the documents pushed to the new Trim record, and this field in the form will be updated with the ID.
• Create Based on Existing (CBoE): If there are multiple versions of eForm applications for the same eForm record, such as a project request, ethics application or contract, only one TRIM record is created. Once an eForm application is synchronised with TRIM, a relationship is established in TRIM for all data and files with the same TRIM record number. All eForm applications and documents related to the Form record will be exported and uploaded to that TRIM record.
These fields are used to establish a link between RME and TRIM and configure the service so that RME can export the eForm document details and files into TRIM.
1. Complete the fields, using the tables below as a guide. There is no format validation so ensure that you enter details carefully.
2. In the toolbar, select Save. When enabled, the service will export document details and files from eForms and upload these in TRIM when the Schedule for TRIM activity is executed in the workflow associated to eForms.
Field Label |
Description |
Enable TRIM integration |
Enables or disables the processing of document files and details into TRIM |
TRIM Configuration |
Define the eForm domain and TRIM record ID format in XML format, as shown in the standard sample below. Points to note: • The XML must begin with <TRIM_CONFIGURATION> and end with </TRIM_CONFIGURATION>. • The
second line and second-last line defines the domain, for example,
for RPR use <eFormDomain name="RPR">
and </eFormDomain> respectively.
• For details about the record ID formats that you can use in the XML, see: Record ID formats. |
TRIM PASSWORD |
Your TRIM system password |
TRIM URL |
URL for the TRIM system |
TRIM USER |
Your TRIM system username |
This table outlines the record ID formats that you can use to define the TRIM Configuration field in XML.
Record ID Format |
Description |
TRIM_RECORD_TYPE |
Main TRIM record type that will be used for each eForm application involved in the export to TRIM |
TRIM_ATTACHMENT_RECORD_TYPE |
Record type used to upload documents to the main record in TRIM |
TRIM_RM_ID_FIELD |
TRIM field to update with the RME Application ID |
TRIM_RECORD_TITLE |
Updates the title of the main TRIM record It contains a list of keys, each of which represent an RME field. The "string_delimiter" attribute is used to separate multiple key values. You can use a character such as a hyphen (-) or a comma (,). |
TRIM_RECORD_Notes |
Updates notes of the main TRIM record It contains a list of keys, each of which represent an RME field. The "string_delimiter" attribute is used to separate multiple key values. You can use a character such as a hyphen (-) or a comma (,). |
TRIM_DOCUMENT_TITLE |
Updates the title of attachments/documents for the TRIM record There are two ways of handling eForm documents and attachments. See: Documents and attachments below. It contains a list of keys, each of which represent an RME field. The "string_delimiter" attribute is used to separate multiple key values. You can use a character such as a hyphen (-) or a comma (,). Keys • DocName • FileName • DomainName (for this key you can add a prefix and postfix character, such as square brackets: domain_pre_fix="[" domain_post_fix="]" - see: Sample snippet: Prefix and postfix character for TRIM_DOCUMENT TITLE domain name key) • TemplateName • StaffId • StaffSurname
There are two ways of handling documents and attachments of eForm applications - you either set up sub-folders, or configure the XML to push them to the main TRIM record folder. • Set up sub-folders • <DOCUMENT_FOLDER>Documents</DOCUMENT_FOLDER> • <EMAIL_FOLDER>Emails</EMAIL_FOLDER>
• Push to main TRIM record folder • Prevent RME updates to existing TRIM
records |
TRIM_DOCUMENT_Notes |
Updates the notes of attachments/documents for the TRIM record It contains a list of keys, each of which represent an RME field. The "string_delimiter" attribute is used to separate multiple key values. You can use a character such as a hyphen (-) or a comma (,). Keys If any of the following are added as a key, the Notes field of the main TRIM record will be populated with the eCode and Title from the eForm application, if available: • Linked_Ethics • Linked_Projects • Linked_Contracts • Linked_Persons • Linked_FundSchemes
Prevent RME updates to existing TRIM records To prevent RME field data overriding an existing TRIM Title data, see: Sample snippet: Prevent RME updates to existing TRIM records. |
This is a standard sample for the Research Project Requests (RPR) domain to provide guidance only; you can configure the XML to suit your needs based on the information above.
<TRIM_CONFIGURATION>
<eFormDomain name="RPR">
<DOCUMENT_FOLDER>Documents</DOCUMENT_FOLDER>
<EMAIL_FOLDER>Emails</EMAIL_FOLDER>
<TRIM_RECORD_TYPE>RPR Record</TRIM_RECORD_TYPE>
<TRIM_ATTACHMENT_RECORD_TYPE>Document</TRIM_ATTACHMENT_RECORD_TYPE>
<TRIM_RM_ID_FIELD>Title</TRIM_RM_ID_FIELD>
<TRIM_RECORD_TITLE string_delimiter="-">
<Key>ECODE</Key>
<Key>TITLE</Key>
</TRIM_RECORD_TITLE>
<TRIM_RECORD_Notes string_delimiter=",">
<Key>ECODE</Key>
<Key>TITLE</Key>
<Key>Linked_Ethics</Key>
<Key>Linked_Projects</Key>
<Key>Linked_Persons</Key>
<Key>Linked_FundSchemes</Key>
<Key>Linked_Contracts</Key>
</TRIM_RECORD_Notes>
<TRIM_DOCUMENT_TITLE string_delimiter="-">
<Key>DocName</Key>
<Key>FileName</Key>
<Key>DomainName</Key>
<Key>TemplateName</Key>
<Key>StaffId</Key>
<Key>StaffSurname</Key>
</TRIM_DOCUMENT_TITLE>
<TRIM_DOCUMENT_Notes string_delimiter=",">
<Key>DocName</Key>
<Key>FileName</Key>
</TRIM_DOCUMENT_Notes>
</eFormDomain>
<TRIM_CONFIGURATION>
In a TRIM_DOCUMENT TITLE record type, to add a prefix and postfix character, such as a square bracket, to the domain key, you can add the following property: domain_pre_fix="[" domain_post_fix="]" . This is the only key that currently supports a prefix and postfix character. For the remaining code, refer to the standard sample above and the information in this help page.
...
<TRIM_DOCUMENT_TITLE
string_delimiter="-" domain_pre_fix="["
domain_post_fix="]">
<Key>DocName</Key>
<Key>FileName</Key>
<Key>DomainName</Key>
<Key>TemplateName</Key>
<Key>StaffId</Key>
<Key>StaffSurname</Key>
</TRIM_DOCUMENT_TITLE>
...
To prevent RME field data overriding an existing TRIM field data, the property “allow_[TRIM_RECORD_NAME]_update=”false” can be added to strings for TRIM_RECORD_TITLE, TRIM_DOCUMENT_TITLE, and TRIM_DOCUMENT_Notes.
For updates, a field with this property will not be pushed to TRIM for existing TRIM records. For new records, the field will be pushed as there is nothing to override. For the remaining code, refer to the standard sample above and the information in this help page.
...
<TRIM_RECORD_TITLE
string_delimiter="-" allow_title_update="false">
<Key>ECODE</Key>
<Key>TITLE</Key>
</TRIM_RECORD_TITLE>
...
The standard integration pushes documents and attachments into sub-folders as explained in Documents and attachments above. To push them to the main TRIM record folder, leave the Document Folder and Email Folder record types empty in the XML.
...
<DOCUMENT_FOLDER></DOCUMENT_FOLDER>
<EMAIL_FOLDER></EMAIL_FOLDER>
...
The standard integration only supports separate configuration for domains. For separate configuration for different eForm templates within the same domain, replace the domain name with "TEMPLATE" and add the following property to the string: template_abbreviations="eForm template abbreviation", where “template abbreviation” represents the exact template abbreviation name. You can add more than one template abbreviation name, separated by a comma. Then you define the remainder of the code as required for the defined template/s. Refer to the standard sample above and the information in this help page.
...
<eFormDomain
name="TEMPLATE" template_abbreviations="HDRCM eForm 12345,
HDRCM eForm 67890">
<DOCUMENT_FOLDER>Documents</DOCUMENT_FOLDER>
<EMAIL_FOLDER>Emails</EMAIL_FOLDER>
<TRIM_RECORD_TYPE>HDR
Record</TRIM_RECORD_TYPE>
...
</eFormDomain>
...
The service processes eForm document details and files as follows:
After a successful update of all documents in TRIM:.
• If the TRIM Integration Status field is included in the eForm, the status is updated to Processed, or Failed if there was a problem. If the integration failed, exceptions will be listed in the export results page and log for further investigation.
• If the Trim Id field is included in the eForm and was originally blank, this field will be updated with the new Trim record number.
• A relationship is created in TRIM for all related eForm records, such as data and files from a new eForm based on an existing one with the same Trim record number, or data and files that were originally exported and uploaded to TRIM with the same TRIM record number.
High-level overview of the TRIM integration process flow
This related item shows a summary of all the scheduled runs of the RME TRIM Integration service which includes the following information:
Column |
Description |
Started |
Date the service began To view the time stamp, double click an entry to see the details. If you export the data from the grid, the time stamp will also be included in the data. |
Completed |
Date the feeder finished To view the time stamp, double click an entry to see the details. If you export the data from the grid, the time stamp will also be included in the data. |
Successful |
Number of records that were successfully imported |
Ignored |
Number of records that were ignored during the import process |
Failed |
Number of records that were not imported |
Log Message |
A brief message for the feeder service if anything has gone wrong To see the full message, click Export at the top right of the grid and export the data. |
To see details of a particular item, click the Open icon next to it in the summary grid to display the Export Results.
Product Key: Interface - TRIM
Page ID: FDR023.htm