Using a Custom Form to Create TRIM Records


17 Dec 2015   Forms Integration

A Custom Form can be configured to function as an E-Form using the Submit TRIM Record submission action. This allows form submissions to be sent as TRIM records to a connected TRIM system via the TRIM Connector asset. E-Forms are especially useful as they create a log of the form submission in both the Squiz Matrix and TRIM systems.


To create an E-Form that submits TRIM records:

  1. Create a Custom Form with questions. For more information on creating and configuring a Custom Form, refer to the Custom Form manual.

    Once the Custom Form is complete, it needs to be configured to send form submissions to a selected TRIM system.
  2. Right click on the Custom Form and select Submission Actions.
  3. In the Add New Action section, select the Create a new action of type: field and from the drop down menu, select Submit TRIM Record, as shown in the figure below.

    The Submit TRIM Record Submission Action
     Submit TRIM Record Submission Action

  4. Click Commit. Additional fields will be displayed on the screen.
  5. In the Existing Actions section, the Submit TRIM Record action will be displayed, however, as it is not yet configured, the Data Source will read No connection details specified and the action will not be valid, as shown in the figure below.

    The Create TRIM Record action without connection
    Submit TRIM Record with no connection details specified

    The Selected Action section will contain the additional fields for configuring the Submit TRIM Record action, as shown in the figure below.

    The Selected Action section for the Submit TRIM Record Submission Action
    Selected Action section of the Submission Actions screen

  6. In the Action Name field, enter the name for the Submission Action. By default, the name entered into this field is Submit TRIM Record.
  7. In the Connection Details section, configure the TRIM bridge that will link Squiz Matrix to the TRIM system where TRIM records should be sent. Enter a connection setup that can be configured or a TRIM Connector can be selected from the Asset Map:

    i) In the WSDL field, enter the URL to the WSDL of the TRIM system.

     ii) In the Username field, enter the username used to connect to the TRIM system.

    iii) In the Password field, enter the password used to connect to the TRIM system. This password must be entered twice for validation purposes.


    i) In the TRIM Connector Asset field, select a configured TRIM Connector to use as the TRIM bridge for the Submit TRIM Record action.
  8. In the Create Record Settings section, configure the settings for creating the TRIM records:

    i) In the Record Type field, select the type of TRIM record to create from the submitted E-Form. Document is the only option available in this field.

    ii) In the Create As User field, enter the name for the user that will be accredited with creating the TRIM record. To use the username of the logged in user completing the form, select the User current logged in Matrix User field.
  9. In the Mandatory Fields Mapping section, enter the information for the mandatory fields on the TRIM record:

    i) In the Record Title field, enter a title for the TRIM record. Keyword replacements can be used in this field.

    ii) In the Parent Record Number field, enter the record number of the parent container where the TRIM record should be stored.

    iii) In the Security Level field, enter a security level of the TRIM record. This will determine who can view and edit the record.

    The following options are available: Public, Unrestricted, In-confidence, Protected and Highly Protected.

    The configuration of these security levels, including access and restrictions, are determined by the TRIM system settings.
  10. In the Additional Field Mapping section, select additional fields to be appended to the TRIM records and the values of these fields. For example, a Notes field can be created with the value as the responses of the E-Form, by using keyword replacements:

    i) In the New Field Name field, select the field name from the drop-down list for the field to be added to the TRIM record.
  11. In the New Field Value field, enter the value to be used for the selected field. Keyword replacements can be used in this field.
  12. Once configured the settings of the Submit TRIM Record action, click Commit. The action will now be displayed as valid in the Existing Actions section, as shown in the figure below.     

    The Create TRIM Record action with connection
    Connected Submit TRIM Record

    Form submissions will now be able to create TRIM records as defined in the Selected Action settings, as shown in the figure below.

    A submission of a TRIM Record using an E-Form
    Submission of a TRIM Record using an E-Form