Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.

Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Profile Attribute Schema

ApiRef2.png Purpose: Describes a Profile Attribute schema.


Describes a Profile Attribute. Each attribute field of the profile corresponds to a recorded schema which details the attribute name, type, and content. Information.png In 8.0.1 release, the configuration of a new attribute schema is performed in the Configuration Manager. Select in "Tenant" the item specific configuration, and under "Business Attributes" 'Contact Attributes'. Then, create a new Business Attribute Value. By default the new Attribute is of type string. To assign another type to the schema, in Annex, create a section "settings", and a key "type" with value "string" or "date".

Predefined Attributes Schema

Default Attributes visible in the Configuration Server are the following:

  • First Name (string)
  • Last Name (string)
  • Phone Number (string)
  • E-mail Address (string)
  • Title (string)

Default 'internal' Attributes (not visible in the Configuration Server) are the following:

  • LastCalledAgent_EmployeeID (string)
  • LastCalledAgent_TimeStamp (date)
  • PreferredAgent_EmployeeID (string)

Additional attributes are available for each active media defined in the Business Attribute "Media Type" of the Configuration Manager:

  • LCA_EmplID_<media> (string)
  • LCA_TimeStamp_<media> (date)
  • Pref_EmplID_<media> (string)

Attributes of type date/time are formatted in UTC ISO 8601: "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
Example: "1981-03-17T02:00:00.000Z"


Field Type Mandatory Description
name string yes The name is unique for each attribute within the given profile.

Important.png In profile attribute schemas, the name is not case-sensitive.

type token yes The attribute type, which can be one of the following types:
  • Boolean
  • String
  • Integer
  • Long
  • Double
  • Date
  • DateTime
  • Currency


  1. The constraints on these types (the minimum and maximum values supported for the integer type) vary with the RDBMS<ref name="RDBMS" />[1]</ref>
  2. Customer profiles are built on top of UCS' Contact Attributes, and support only String and DateTime attribute types. However, all attribute types are supported for profile extensions.
default numeric or string no Provides a default value for the attribute.
For numeric attributes, you do not need quotation marks. Quotation marks are for string, date, and datetime attributes. By default, the date/time format is ISO 8601 UTC <ref>Wikipedia ISO 8601</ref>:[YYYY]-[MM]-[DD]T[HH]:[mm]:[ss].[SSS]Z.
length integer no Reserved to attributes of type String. Defines the maximum number of characters for the string.
  • Default length is 256;
  • Maximum length is 4000.
encrypt Boolean no
  • false by default.
  • true if the server must encrypt the attribute value before saving it to the UCS database.
mandatory Boolean no
  • false by default;
  • true if the attribute is mandatory when inserting a new Profile Extension record.

<references />

Related Operation

This page was last edited on November 23, 2017, at 16:00.


Comment on this article:

blog comments powered by Disqus