profileFieldSubcategory Data Type

A profile field subcategory is a collection of fields and field groups that define a specific piece of profile information Examples: Credit Cards, Driver's Licenses, Passports.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
displayName string element 0/1 The Human readable name for the Sub Category.
displayOrder int element 0/1 The order which we expect the field to be displayed on the form Example: you'd want first name to be lower than last name
fields list of profileField element 0/unbounded The Fields that belong to this collection. Example Name, Address, Credit Card Number, etc.
headerText string element 0/1 Up for deprecation. Do Not use.
hidden boolean element 0/1 A flag that determines whether this sub category should show on the form
multipleInstances boolean element 0/1 A flag that defines whether there can be multiple versions of this collection. Example: A user can have multiple Passports or credit cards
Properties inherited from baseHibernateEntity
id long element 0/1 The unique internal ID of the object.
version long element 0/1 For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from baseEntity
violations list of simpleViolation element 0/unbounded A list of constraint violations, if any, that this object has.

Example

<profileFieldSubcategory>
  <displayName>...</displayName>
  <fields>
    <propertyName>...</propertyName>
    <displayName>...</displayName>
    <type>
      <code>...</code>
      <name>...</name>
      <dropdown>...</dropdown>
    </type>
    <displayOrder>...</displayOrder>
    <hidden>...</hidden>
    <readonly>...</readonly>
    <defaultValue>...</defaultValue>
    <required>...</required>
    <requiredInGroup>...</requiredInGroup>
    <fullDisplayName>...</fullDisplayName>
    <shouldMask>...</shouldMask>
    <maskBeginIndex>...</maskBeginIndex>
    <maskEndIndex>...</maskEndIndex>
    <minLength>...</minLength>
    <maxLength>...</maxLength>
    <custom>...</custom>
    <customFieldName>...</customFieldName>
    <fieldGroup>
      <code>...</code>
    </fieldGroup>
    <preferred>...</preferred>
    <encrypted>...</encrypted>
    <fieldVisibility>
      <name>...</name>
      <description>...</description>
    </fieldVisibility>
    <setOnUserCreation>...</setOnUserCreation>
    <composite>...</composite>
    <childFields/>
    <id>...</id>
    <version>...</version>
  </fields>
  <displayOrder>...</displayOrder>
  <hidden>...</hidden>
  <multipleInstances>...</multipleInstances>
  <headerText>...</headerText>
  <id>...</id>
  <version>...</version>
  <violations/>
</profileFieldSubcategory>