Properties

A custom property is an attribute of an entity that's unique to each client. You can create a custom property through the user interface or through an API, or you can import it from another instance. Once added, the custom property is available for use in page configurations, filters, and many configuration areas (for example, search fields, duration field, and so on).

You can create these types of properties:
  • String: These are custom properties that require alphanumeric entries. These can include free text boxes, URLs, phone numbers, or email addresses.

  • Integer: These are custom properties that require numeric entries. This option can also be used for check boxes.

  • Enumeration: These are custom properties that require selections from fixed lists. Option buttons and combo (drop-down lists) boxes are common examples of this property type.

  • File: These are custom properties that require some type of file upload. These could include MIME types such as .gif, .jpg, .pdf, .mpeg, .zip, html, .wav, or .doc. Examples of File properties could be customer signatures or even mobile worker photos.

Each entity (for example, activity, resource, inventory, and users) contains a set of associated attributes. For example, resource records might contain attributes such as name, contact information, and physical attributes such as gender or a photograph. These attributes within Oracle Field Service are combinations of fields or custom properties.
Properties with the Type “Field” are the native system properties that are available for the specified entities. For example, Name (property label, cname) is associated with an Activity, and Serial Number (property label, invsn) is associated with Inventory. Field type of properties can be mapped with similar client properties.
Note:
  • Multiple fields or properties with the same name can exist. For example, Name can be a customer’s name (property label, cname) or a resource’s name (property label, pname). In this example, each Name property is assigned to a different entity and has a different property label.
  • When custom property values exceed 255 bytes, the entire value is shown in the activity details, API responses, and Outbound Messages. However, only the first 255 bytes are used for search, visibility conditions, activity inventory list columns and their sorting, travel, activity duration, visit, and Work Zone Keys. If you create a condition with long values, only the first 255 bytes are used with historic data; all the long values that are added after you create the new condition will use the full set of data. Further, if a field with a long value is added to a page such as List view, only the first 255 characters are shown.