Skip to main content

UTA Provider/Consumer Relationships

Anthony Eidt
Updated

Overview

The UTA Provider/Consumer Relationships facilitate the exchange of data between distinct UTAs.

In this framework, one UTA serves as the provider, enabling access to the information contained within that UTA from a second UTA.

The second UTA functions as the consumer, retrieving information from the provider UTA.

Both Level One and Level Two entities may be utilized within this Provider/Consumer relationship.

 

Enable UTA Provider / Consumer Connections

Initially, it is essential to designate one UTA as the provider, thereby allowing the information contained within that UTA to be accessible from a secondary UTA. It is also necessary to indicate that a second UTA will function as the consumer, retrieving information from the provider UTA.

Enable UTA Connection as Provider

  • System Administration (gear icon) >> Tracking Applications >> [Edit] *UTAname >> Connectivity (tab) >> [Enable UTA Connection as Provider - grants or activities can be linked to objects from other UTAs as providers (parent)]

Enable UTA Connection as Consumer

  • System Administration (gear icon) >> Tracking Applications >> [Edit] *UTAname >> Connectivity (tab) >> [Enable UTA Connection as Consumer - grants or activities can be linked to objects from other UTAs as consumers (child)]

Configure Provider UTA Connection Settings

Subsequently, it is imperative to formally associate the provider UTA with the consumer UTA, including the selection of whether the link will be based on Level 1 or Level 2 entities.

  • L1 Provider Connection Settings - Configure L1 Provider UTA connection settings: Select this option if you wish to link Level 1 records in the Provider UTA with a consumer UTA.
  • L2 Provider Connection Settings - Configure L2 Provider UTA connection settings: Select this option if you wish to link Level 2 records in the Provider UTA with a consumer UTA.

1. Click on either of these options to navigate to the UTA Connection Settings page.

2. The UTA Connection Settings comprise the following sections:

  • Consumer Application: select the UTA you wish to designate as the consumer UTA from a list of all UTAs that have been enabled as consumer UTAs.
  • Consumer Level: select whether the consumer UTA will access the provider UTA data from Level 1 records or Level 2 records.
  • Template: If you selected the L1 Provider Connection Settings, this will list all Level 1 Templates in the provider UTA. If you selected the L2 Provider Connection Settings, this will list all Level 2 Types in the provider UTA. You may choose to link records of a specific type or template in the Provider UTA or select All if all Provider UTA records should be accessible, irrespective of type or template.
  • Status: If you selected the L1 Provider Connection Settings, this will list all Level 1 statuses in the provider UTA. If you selected the L2 Provider Connection Settings, this will list all Level 2 statuses in the provider UTA. You may choose to link records of a specific status in the provider UTA with a consumer UTA or select All if all provider UTA records should be accessible regardless of status.
  • ID Field: The field designated as the unique identifier for the provider records.

3. Complete the Connection Settings as required and then click Save.

Configure Provider / Consumer UTA List Views

Consumer List View

System Administration (gear icon) >> Tracking Applications >> [Edit] *UTAname >> Connectivity (tab) >> [Consumer List View from *]

Provider List View

System Administration (gear icon) >> Tracking Applications >> [Edit] *UTAname >> Connectivity (tab) >> [Provider List View from *]
  • UTA Consumer Level 1 List View from A Consumer - Create and manage list view for UTA consumer Level 1: Select this option if you wish to configure the list view for UTA consumer Level 1 records.
  • UTA Consumer Level 2 List View from A Consumer - Create and manage list view for UTA consumer Level 2: Select this option if you wish to configure the list view for UTA consumer Level 2 records.

Configure Consumer UTA Connection Roles

Additionally, it is possible to define a Role for Consumer/Provider relationships, including the capability to incorporate role-based custom fields to monitor attributes of the association between specific consumer and provider records. These roles can then be utilized when adding a UTA provider to a Level 1 record.

  1. Select Connection Roles
  2. You will be redirected to the UTA Connection Roles page.
  1. Click New - UTA Connection Roles to initiate the addition of a new role.
  1. Enter the necessary details in the available fields and click Save.

Enable UTA Consumer / Provider Standard Fields

The Standard UTA Level 1 fields, namely UTA Providers and UTA Providers (L2), are employed to establish a direct link between a record from a provider UTA and a record from a consumer UTA.

Upon adding either of these fields to the consumer UTA Level 1 entity, it will manifest as a section within the Level 1 entity;

 

Variables and Provider/Consumer Records

The following syntax may be employed to display a list of consumers or providers associated with a record.

[#(?object=objectname;{options})~standardfieldname~ $customfieldname$#]

Where:

  • objectname denotes the name of the item to be listed.

Options include:  utaproviderL1, utaproviderL2, utaconsumerL1 or utaconsumerL2

  • standardfieldname represents the name of a standard field (enclosed between tildes ~)
  • customfieldname indicates the name of a custom field (enclosed between dollar signs $)

Notes:

  • You may refer to Custom Fields in the list using the Custom Field ID instead of the field name, still enclosed between dollar signs ($12345$)
  • You may incorporate text as well as variables within the [#...#] syntax.
  • When utilizing this syntax for Web Page Views, Read Only – System Variables etc., it is generally advisable to include HTML table formatting within the [#...#] syntax (refer to examples below). For MS Word Merge custom fields, the table defined in the MS Word Template document should have columns delimited by pipes (|) within the [#...#].
  • ~Index~ can be employed to number the lines (1, 2, 3...) Note: ~index~ does not function for all lists. For instance, it cannot be used when listing contacts associated with a Level 1.
  • ~Index~ (capital 'I') initiates numbering at 1, ~index~ (lowercase 'i') begins numbering at 0.

Template Formulas and Provider/Consumer Records

  • If you are employing template formulas to populate Level One fields with details regarding associated UTA providers, the following syntax must be utilized:
@level1.fieldname@=@level1.utaprovider.count(*)@;
  • If you are utilizing template formulas to populate Level One fields with details about associated UTA consumers, the following syntax is required:
@level1.fieldname@=@level1.utaconsumer.count(*)@;
  • If you are using template formulas to populate Level Two fields with details regarding associated Level One UTA providers, the following syntax should be applied:
@level2.fieldname@=@level2.utaprovider.count(*)@;
  • If you are employing template formulas to populate Level Two fields with details about associated Level One UTA consumers, the following syntax must be utilized:
@level2.fieldname@=@level2.utaconsumer.count(*)@;

Helpful Links