CREATE USER FIELD

Creates a custom data definition through Proactive XS for Central.

Supported Script Types

Phone

Properties

Name
The name you would like to give to a custom data definition (as shown in Central). Cannot exceed 200 characters.
DataType
String, Phone, Boolean, Int, Decimal, Date, Time, etc.
DefaultValue
The value you would provide to any record without a matching mapping. Cannot exceed 200 characters.
Associations
Applies only to the Phone data type. A correlation between a phone data type and another custom data definition. Make sure the custom data definition is the same data type as the associated field.

Branches

Default
The branch the script will take if no other conditions are met to take a different branch.
OnError
The branch the script will take if an unexpected error occurs.
OnFieldInUseByProcessingFilter
The branch the script will take if you are changing an existing field currently in use by a filter in process.
OnInvalidDataType
The branch the script will take if the data type you provided does not match a supported data type.
OnNoNameProvided
The branch the script will take if the Name property is left blank.
OnDataTypeMismatch
The branch the script will take if you provided a subfield with a different data type than the expected data type. For example, if you give compliance a Date data type rather than a Boolean.
OnUserDefinedFieldNotFound
The branch the script will take if your subfield is mapped to a non-existent field.
OnInvalidSubField
The branch the script will take if the subfield cannot be interpreted by NICE inContact.
OnDefaultValueDoesntMatchDataType
The branch the script will take if the specified default value does not match the specified data type. For example, if the default value is a string, but the data type is an integer.
DataTypeDoesntSupportDefaultValue
The branch the script will take if the data type does not support the default value, for example, the phone data type.
FieldExceededLength
The branch the script will take if the Name property exceeds 200 characters.
InUseAsSubtype
The branch the script will take if the field is currently in use as a subtype of another field, specifically if you are changing the data type.

Tips and Tricks

  • CREATE USER FIELD is for use with Proactive XS only.
  • Any data definition type you can create in Central can also be created through CREATE USER FIELD.

Phone Script Example Using CREATE USER FIELD

The script shown below sets all the paths for CREATE USER FIELD, which enables you to create a new custom data definition.

Double-click the Snippet action to view the Snippet Properties. Click here to view these properties in a text view.

Would you like to download this script?