profileField Data Type

An Profile field is a mapped property for the profile logic system. Each field is mapped by a code which we then use to translate into OBE profiles. The data stored for each field is universal though. We store the same data formats for concur as we do for resx. We only translate the data when we push to external systems.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
childFields list of profileField element 0/unbounded A collection of fields that complete this field. Example: Phone Number has children -- Country Code, Area Code, Number, Extension
composite boolean element 1/1 DO NOT USE. UP FOR DEPRECATION.
custom boolean element 0/1 Is this field a custom value? Custom field are generally things like UDIDs that are part of the company information, like cost centers and departments.
customFieldName string element 0/1 The sync name of the custom field. This is used for systems like the OBE sync where the mapped field would be set by an admin or online tech.
defaultValue string element 0/1 The default value for the field
displayName string element 0/1 The name of the property for the layman.
displayOrder int element 0/1 The position of the field relative to other fields in the same subcategory.
encrypted boolean element 1/1 DO NOT USE. UP FOR DEPRECATION.
fieldGroup profileFieldGroup element 0/1 The group that this field falls under. Should this be grouped under credit cards, passports, etc? This is generally used when we push profiles to an external system. We need to be able to categorize values into identifiable classes like passports or visas.
fieldVisibility profileFieldVisibility element 0/1 DO NOT USE. UP FOR DEPRECATION.
fullDisplayName string element 0/1 The full name of the property, so for example instead of just "Name", this field would be something like "Credit Card Default Name". This would be annoying to the user if we displayed the full name on every field. So we usually just use it on the form editor so the editor can know exacly what field they are editing.
hidden boolean element 0/1 Should this field be hidden from the user?
maskBeginIndex long element 0/1 At what point in the string should the mask start?
maskEndIndex long element 0/1 At what point in the string should the mask end?
maxLength long element 0/1 Maximum length of the value.
minLength long element 0/1 Minimum length of the value.
preferred boolean element 0/1 Is this field preferred over fields of the same type? At the moment this only applies to phone numbers.
propertyName string element 0/1 The name of the property in the OBECore request object. For nested properties, use the . as a delimiter to path to the property from the root object.
readonly boolean element 0/1 Should the user be able to edit the field?
required boolean element 0/1 Is this field required?
requiredInGroup boolean element 0/1 Is this field required in its group?
setOnUserCreation boolean element 0/1 A flag that tells us if this value is already set. These do not need to be filled out by the traveler.
shouldMask boolean element 0/1 Should this field be masked when it is returned to the user?
type profileInputType element 0/1 The default type for this property. For instance, a name field would be alphanumeric.
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

<profileField>
  <propertyName>...</propertyName>
  <displayName>...</displayName>
  <type>
    <code>...</code>
    <name>...</name>
    <dropdown>...</dropdown>
    <id>...</id>
    <version>...</version>
  </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>
    <id>...</id>
    <version>...</version>
  </fieldGroup>
  <preferred>...</preferred>
  <encrypted>...</encrypted>
  <fieldVisibility>
    <name>...</name>
    <description>...</description>
    <id>...</id>
    <version>...</version>
  </fieldVisibility>
  <setOnUserCreation>...</setOnUserCreation>
  <composite>...</composite>
  <childFields/>
  <id>...</id>
  <version>...</version>
  <violations/>
</profileField>