Jump to: navigation, search

Making an Attribute Searchable from the Desktop

For both interactions and contacts, many attributes are not directly searchable from the desktop.

This section describes the way to make these attributes searchable from the desktop.

You do this by adding an option called is-sortable to the Annex section of the corresponding Business Attribute. Do not confuse this option with the is-searchable option. The following table compares the two.



Used with


Makes attribute searchable from desktop

Interaction attributes, contact attributes


Makes UCS use the attribute in identifying contacts (at runtime)

Contact attributes only

By default, all attributes that are attached to an interaction are stored in the AllAttributes attribute of the Interaction entity. You can make searchable any attribute that is represented in the Configuration Server database by a Business Attributes object of type Interaction Attributes. Examples are:

  • Category
  • Disposition Code
  • Interaction Subtype
  • Interaction Type
  • Language
  • Media Type
  • Priority
  • Reason Code
  • Service Type
  • StopProcessing Reason

The Interaction entity includes attributes StrAttribute1–StrAttribute10 and IntAttribute1–IntAttribute5, which exist to enable you to make attached attributes searchable. These attributes StrAttribute1–StrAttribute10 and IntAttribute1–IntAttribute5 may be referred to collectively as replicant attributes,as explained below.

To be able to perform lookup on any of the attached attributes, use the following procedure.

Making an attached attribute searchable

  1. In Configuration Manager, be sure that Properties windows show their Annex tabs. If they do not:
    1. Go to the View menu and select Options.
    2. In the resulting dialog box, select the Show Annex tab in object properties check box.
  2. In the tenant for your UCS, go to Business Attributes > Interaction Attributes > Attribute Values.
  3. Open the Properties window for the attribute that you want to make searchable (for example, Service Type).
  4. On the Annex tab, create a section named settings if it does not already exist.
  5. In this settings section, create an option named is-sortable and give it the value true.
    Although the option name refers to being sortable, its real effect is to make attributes searchable.
  6. If the attribute is of type string, you are finished. If it is of type integer, you must create an additional option, also in the Settings section, named type with the value integer.

Once you have configured an attached attribute as searchable, UCS takes its value as stored in AllAttributes and copies it as the value of one of the replicant attributes. To find out which replicant attribute copies a given attached attribute, look at the content of the IxnAttributeMetaData table. For example, if you have configured the ServiceType attribute to be searchable, you can find out which replicant attribute copies its value by using the following SQL request:

SELECT MappingColumnName FROM IxnAttributeMetaData WHERE TheName=’ServiceType’;

Please also note the following:

  • This replication process only applies to interactions created or updated after' you perform the configuration described in this section. The replication process is not applied to interactions retroactively. The replicant attribute in older records will remain empty.
  • By default, the replicant attribute that replicates the Interaction attribute does not have any database index. To increase performance during queries, consider adding index(es) to those replicant attributes that contain copied attributes.
  • Replicant attributes are read-only from outside UCS. UCS is responsible for synchronization of their content whenever Interaction.AllAttributes is updated.
  • The mapping between a searchable interaction attribute and a replicant attribute is based on the type (string or integer) of the business attribute declared in the Configuration Server database (string by default). UCS chooses from among the replicant attributes of the proper type that are not already associated with an attached attribute. It does this until no more replicant attributes are available.
  • Once a replicant attribute has been used for a particular attribute, it is dedicated to that attribute: it cannot be used for another one. The only modification you can make is to configure a searchable attribute to be no longer searchable. The replicant attribute that copied this attribute’s values will then retain those values for existing records and for any new records.
This page was last modified on August 1, 2014, at 16:28.


Comment on this article:

blog comments powered by Disqus