Skip to main content

Configure UTA Provider/Consumer Relationships

Updated

UTA Provider/Consumer Relationships allow two separate UTA/modules to share record data without merging into a single UTA/module. One UTA/module acts as the provider, making its records available to a second UTA/module configured as the consumer. Connection settings link provider and consumer records at Level 1 or Level 2, filtered by type, template, or status. Connection roles track role-based attributes of the association between specific provider and consumer records, and standard fields display that link directly within each UTA/module. For UTA Provider and Consumer reference information, see UTA Provider and Consumer Variables and Formulas Reference.

Who: Global administrators

When to Use UTA Provider/Consumer Relationships

Use UTA Provider/Consumer Relationships when:

  • Two separate UTA/modules need to share record data without merging into a single UTA/module.
  • A consumer UTA/module needs to display or reference provider UTA/module records filtered by level, template, or status.
  • Role-based custom fields are needed to track attributes of individual provider-to-consumer record relationships.
  • Linking a budget management UTA/module with an application management UTA/module during the approval process, to allocate payments from the budget UTA/module to specific grant applications.

↑ Back to top

Enable UTA Provider/Consumer Connections

To set up a Provider/Consumer relationship, designate one UTA/module as the provider and a second UTA/module as the consumer.

Enable a UTA/module to Act as the Provider

To enable a UTA/module to act as the provider, making the information held within that UTA/module accessible from a consumer UTA/module:

  1. Click the Menu icon in the upper navigation bar, and then select the relevant UTA/module from the Applications drop-down menu.
  2. Click the Configuration Settings gear for the UTA/module.
  3. Click the Connectivity tab.
  4. Toggle Enable UTA Connection as Provider on.
  5. Click Save.

Enable a UTA/module to Act as the Consumer

To enable a UTA/module to act as the consumer, allowing it to access information held within the provider UTA/module:

  1. Click the Menu icon in the upper navigation bar, and then select the relevant UTA/module from the Applications drop-down menu.
  2. Click the Configuration Settings gear for the UTA/module.
  3. Click the Connectivity tab.
  4. Toggle Enable UTA Connection as Consumer on.
  5. Click Save.

↑ Back to top

Configure Provider UTA Connection Settings

After enabling the provider and consumer UTA/modules, associate them by configuring the Provider UTA Connection Settings. This step also defines whether the connection links Level 1 or Level 2 records.

To configure the Provider UTA Connection Settings:

  1. Click L1 Provider Connection Settings or L2 Provider Connection Settings.
    • L1 Provider Connection Settings — Select this option to link Level 1 records in the provider UTA/module with a consumer UTA/module.
    • L2 Provider Connection Settings — Select this option to link Level 2 records in the provider UTA/module with a consumer UTA/module.
  2. Complete the following fields for the Provider UTA Connection Settings:
    • Consumer Application — Select the UTA/module to designate as the consumer from the list of enabled consumer UTA/modules.
    • Consumer Level — Select whether the consumer UTA/module will access provider data from Level 1 or Level 2 records.
    • Type — Select a specific Level 1 type (for L1 settings) or Level 2 type (for L2 settings) in the provider UTA/module, or select All to make all provider UTA/module records accessible regardless of type or template.
    • Status — Select a specific status to link only provider records at that status, or select All to include provider records at any status.
    • Consumer Types — Select a specific type in the consumer UTA/module that can link to provider records, or select All to make all consumer UTA/module records able to link to provider records. The types displayed depend on the Consumer Level.
    • Consumer Status — Select a specific status to allow only consumer records at that status, or select All to make consumer UTA/module records able to link to provider records regardless of status. The status displayed depends on the Consumer Level.
    • ID Field — Select the field designated as the unique identifier for provider records.
  3. Click Save.

↑ Back to top

Configure Provider/Consumer UTA List Views

To configure a list view that display provider or consumer records within a UTA/module:

  1. Click the Menu icon in the upper navigation bar, and then select the relevant UTA/module from the Applications drop-down menu.
  2. Click the Configuration Settings gear for the UTA/module.
  3. Click the Connectivity tab.
  4. For Provider: If the UTA/module is configured as a provider, a list of the UTA/modules selected as consumers in the Provider Connection Settings displays, with two links for each consumer UTA/module. Select the appropriate option:
    • UTA Consumer Level 1 List View — Select this option to configure the list view for consumer Level 1 records as displayed within the provider UTA/module.
    • UTA Consumer Level 2 List View — Select this option to configure the list view for consumer Level 2 records as displayed within the provider UTA/module.
  5. For Consumer: If the UTA/module is configured as a consumer, a list of the associated provider UTA/modules displays, with two links for each provider UTA/module. Select the appropriate option:
    • UTA Provider Level 1 List View — Select this option to configure the list view for provider Level 1 records as displayed within the consumer UTA/module.
    • UTA Provider Level 2 List View — Select this option to configure the list view for provider Level 2 records as displayed within the consumer UTA/module.

↑ Back to top

Configure Consumer UTA Connection Roles

Define roles for Provider/Consumer relationships to track role-based attributes of the association between specific provider and consumer records. Once created, these roles are available when adding a UTA/module provider to a Level 1 record.

To define a connection role:

  1. Click the Menu icon in the upper navigation bar, and then select the relevant UTA/module from the Applications drop-down menu.
  2. Click the Configuration Settings gear for the UTA/module.
  3. Click the Connectivity tab.
  4. Click Connection Roles to open the UTA Connection Roles page.
  5. Click the New Role [+] button to add a new role.

  6. Enter the required details, including restricting to certain providers. Edit Connection Role interface

     

    The connection role displays with two panels on the left side, allowing the creation of custom fields specific to the association of the provider and consumer:

    • L1-L1 Fields — Custom fields accessible from the association of Level 1 provider records with Level 1 consumer records.
    • L1-L2 Fields — Custom fields accessible from the association of Level 1 provider records with Level 2 consumer records.
  7. Click Save.

↑ Back to top

Enable UTA Provider/Consumer Standard Fields

The standard Level 1 fields UTA Providers and UTA Providers (L2) create a direct link between a record in the provider UTA/module and a record in the consumer UTA/module. When either field is added to the consumer UTA Level 1 entity, it appears as a section within that entity.

To configure provider or consumer UTA/module settings:

  1. Click the Menu icon in the upper navigation bar, and then select the relevant UTA/module from the Applications drop-down menu.
  2. Click the Configuration Settings gear for the UTA/module.
  3. Click the Level 1 or Level 2 tab as appropriate.
  4. Click Standard Fields in the Level 1 or Level 2 section, depending on where the list of consumer records should appear.
  5. Click the Name of the standard field to add.
    • Provider: The relevant options for provider records are:
      • UTA Consumer — available for both Level 1 and Level 2 standard fields.
      • UTA Consumers (L2) — available for Level 1 standard fields only.
    • Consumer: The relevant options for consumer records are:
      • UTA Provider — available for both Level 1 and Level 2 standard fields.
      • UTA Provider (L2) — available for Level 1 standard fields only.
  6. Enter text in the Caption field for any specific terminology.
  7. Click Save.

The standard field now displays in the UTA/module, using the defined nomenclature.

↑ Back to top

Helpful Links