profileFieldCategory Data Type

A profile field category is a combined group of subcategories that lets us keep our display tidy when we render the profile form.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
displayName string element 0/1 The label for the category.
displayOrder int element 0/1 The order of display in relation to other categories.
headerText string element 0/1 DO NOT USE. UP FOR DEPRECATION.
hidden boolean element 0/1 Should this category be hidden from the user?
subcategories list of profileFieldSubcategory element 0/unbounded A collection of subcategories under this category.
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

<profileFieldCategory>
  <displayName>...</displayName>
  <hidden>...</hidden>
  <subcategories>
    <displayName>...</displayName>
    <fields>
      <propertyName>...</propertyName>
      <displayName>...</displayName>
      <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/>
      <preferred>...</preferred>
      <encrypted>...</encrypted>
      <fieldVisibility/>
      <setOnUserCreation>...</setOnUserCreation>
      <composite>...</composite>
      <childFields/>
    </fields>
    <displayOrder>...</displayOrder>
    <hidden>...</hidden>
    <multipleInstances>...</multipleInstances>
    <headerText>...</headerText>
    <id>...</id>
    <version>...</version>
  </subcategories>
  <displayOrder>...</displayOrder>
  <headerText>...</headerText>
  <id>...</id>
  <version>...</version>
  <violations/>
</profileFieldCategory>