CustomField

Represent a document-level custom field. Custom fields provide a way for customers of the TVS system to add their own custom properties, such as department or reference numbers to documents.

Note

Document-level custom fields are configured for the TrustID Cloud through the configuration of the service.

CustomField.DataType

= DataType

The data type of the document-level custom field.

See also

CustomFieldDataType for more information about the custom field data type.

CustomField.DisplayName

= DisplayName

The display name of the document-level custom field.

CustomField.Help

= Help

Additional help text that describes the purpose of the document-level document field.

CustomField.Index

= Index

An integer value between 0 and 9 which identifies the internal custom field slot that is used to store the document-level custom field.

The TrustID Cloud only supports up to 10 data slots that can be used to assign document-level custom fields.

CustomField.PropertyName

= PropertyName

The internal name of the document-level custom field.

CustomField.Required

= Required

true if this document-level custom field is mandatory.

CustomField.Value

= Value

The actual value of this document-level custom field encoded as a string value.

CustomField.Values

= Values

Optional: A list of allowed values for this document-level custom field.