WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:31:33Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:45:03Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Bgrenon: Published

2020-06-08T14:26:04Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Create and Manage User-defined Field Labels
|TocName=Create and Manage User-defined Field Labels
|Context=Learn how to change the default label for a user field.
|ComingSoon=No
|Platform=PureEngage
|Role=Administrator
|Application=CX Contact
|Section={{Section
|alignment=Vertical
|structuredtext=By default, all user-defined fields in a contact list are labelled as Other1, Other2, Other3, and so on, but you can override the default labels to clearly identify what the field is used for. For example, if you use Other21 to store the current balance remaining on a contact's account, you can change the field's Other21 label to Balance.

In this article, you'll learn how to change the default label for a user field. More specifically, you'll learn the following:

*{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=CreateSchema|display text=Create the labeling schema}} that stores all user fields and their label properties
*{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=CreateFieldsAndLabels|display text=Create or edit user fields in a labeling schema and define their label properties}}
*Apply a labeling schema to any of the following:
**{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=ApplytoList|display text=Contact list}}
**{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=ApplytoCampaign|display text=Dialing profile, campaign template, or campaign group}}
**{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=ApplytoRule|display text=List rules}}
|Status=No
}}{{Section
|sectionHeading=Create a Labeling Schema
|anchor=CreateaSchema
|alignment=Vertical
|structuredtext=A labeling schema is the shell that stores all defined {{Link-SomewhereInThisManual|topic=FieldLabels|anchor=LabelProperties|display text=label properties}} for a user field in a contact list. You must have a labeling schema in place before you can create or edit user fields and define their label properties.

To create the labeling schema, go to the '''Lists -> Labels''' page and click '''New'''.

Next, specify a name and a description for the labeling schema and click '''Create'''. You'll return to the main '''Labels''' page and see the new labeling schema you just created.

[[File:CXC_NewLabelingSchema.png|700px|center]]



The main Labels page displays the following properties for each labeling schema:

{{{!}}
!Property
!Description
{{!}}-
{{!}}'''Name'''
{{!}}Name of the labeling schema.
{{!}}-
{{!}}'''Description'''
{{!}}The description of the schema.
{{!}}-
{{!}}'''Data Fields'''
{{!}}The number of data fields stored in the labeling schema. '''Note:''' Every labeling schema contains the standard 20 user fields (Other1-Other20) included in a contact list, so the minimum value in this field will always be 20.
{{!}}-
{{!}}'''Created Date'''
{{!}}The date you created the labeling schema.
{{!}}-
{{!}}'''Actions'''
{{!}}
Use the '''Actions''' menu to do any of the following:

*Click the pencil icon to edit the labeling schema (name and/or description) or the fields and their label properties contained within the schema.
*Click the trash can icon to delete an entire labeling schema. This deletes all user fields and defined label properties contained within that schema.
*Click the page icon to duplicate an entire labeling schema. This duplicates the schema name (with the suffix duplicate appended to it), description, all user fields and label properties.
{{!}}-
{{!}}}

{{NoteFormat|Every Labels page contains a default labeling schema that cannot be deleted.}}
|Status=No
}}{{Section
|sectionHeading=Create or Manage User Fields and Labels
|anchor=CreateFieldsAndLabels
|alignment=Vertical
|structuredtext=Once you've created the labeling schema, you can click its name and do any of the following:

*{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=NewField|display text=Create a new user field and define its label properties}}
*{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=MultipleFields|display text=Create multiple user fields simultaneously}}
*{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=EditFields|display text=Edit existing user fields or label properties}}
*{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=ImportLabels|display text=Import Labels}}
*{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=DeleteFields|display text=Delete user fields}}
*{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=SearchFields|display text=Search for a user field}}

{{AnchorDiv|NewField}}
===Create a New User Field and Define Label Properties===

To create a new user field in your labeling schema and define its {{Link-SomewhereInThisManual|topic=FieldLabels|anchor=LabelProperties|display text=label properties}}, click the name of the labeling schema on the main '''Labels''' page. You'll go to the '''User Fields''' page that lists all user fields and corresponding label properties in that labeling schema.

Click '''New''' and define the label properties as described in the table below. An example follows.

Click ''Import'' and import label definitions from a '''.json''' file. For details see {{Link-SomewhereInThisManual|topic=FieldLabels|anchor=ImportLabels|display text=Import Labels}}.

{{AnchorDiv|LabelProperties}}
{{{!}}
!Property
!Description
{{!}}-
{{!}}'''Field Name'''
{{!}}This is the default field name - Other1, Other2, Other3, and so on. When you create a new user field, the system auto-populates the value of '''Field Name''' so that all user fields are in sequential order. For example, if you currently have 27 user-defined fields in your contact list (Other1-Other27) and you click '''New''' to create a new user field, the '''Field Name''' value will default to Other28. You cannot edit this value.
{{!}}-
{{!}}'''Label'''
{{!}}This is the label that corresponds to the field name.
{{!}}-
{{!}}'''User Data Key Name'''
{{!}}Used to identify the type of data stored in a field within the contact list.
{{!}}-
{{!}}'''Display'''
{{!}}Select this option if you want the new field label to override the default Other field label in all sections of the user interface that display contact list fields.
{{!}}-
{{!}}'''Attach to calls'''
{{!}}Select this option if you want the new user field to be attached to outbound calls, so that agent desktop applications can access the data.
{{!}}-
{{!}}}

Once you define the properties and select '''Save''', you'll return to the '''User Field'''s page and see the new label properties that correspond to your user field.

{{{!}}
{{!}}-
{{!}}'''Example'''
{{!}}
If you want to use the Other21 field to store the balance owing on a customer's account, you could use the following label properties:

*Field Name: Other21 (you cannot change this)
*Label: Balance
*User Data Key Name: USR_BALANCE_OWING

[[File: CXC_LabelExample.png|center]]
{{!}}-
{{!}}}

{{AnchorDiv|MultipleFields}}
===Create Multiple User Fields===

If you want to create more than one new user field, go to the '''User Fields''' page and click '''New Multiple'''.

Next, in the '''Field''' count box, enter the number of new fields you want to create. If, for example, you have 20 existing user fields and you want to add 12 new user fields, type 12 in this box. When you're finished, the system will add 12 new fields in sequential order (Other21-Other32).

You will then select each new field individually to define its {{Link-SomewhereInThisManual|topic=FieldLabels|anchor=LabelProperties|display text=label properties}}.

{{AnchorDiv|EditFields}}
===Edit User Fields===

To edit the {{Link-SomewhereInThisManual|topic=FieldLabels|anchor=LabelProperties|display text=label properties}} of a user field, go to the '''User Fields''' page and click the name of the field (in the '''Field Name''' column) or click the corresponding pencil icon to open and edit the field's properties.

{{NoteFormat|You cannot edit the '''Field Name''' for any user field.}}

{{AnchorDiv|ImportLabels}}
===Import Labels===

To import labels from a '''.json''' file, click the '''Import''' icon.

Next, in the '''Import Label Definition from file''' window, click '''Select file (.json)'''.

After you select the .json file click '''Import'''. The new label is created and an '''Import Label''' tab is opened for the imported label.

Review the details, make modifications if necessary and click '''Create'''. The imported label will now appear in the '''Labels''' table.

{{AnchorDiv|DeleteFields}}
===Delete User Fields===

To delete a user field, click the trash can icon that corresponds to that user field or click the check box to the left of the field name and click the trash can icon at the top of the list of user fields.

{{NoteFormat|The following rules apply:
*Because the user fields in a contact list are ordered sequentially, you can only delete the last user field in a sequence. For example, if you have 27 user fields in your schema (Other1-Other27) and you want to delete Other25, you must first delete Other27 and then Other26.
*Because Other1-Other20 fields are standard fields in a contact list, those fields cannot be deleted. You can only edit the label properties for those fields.}}

{{AnchorDiv|SearchFields}}
===Search for a User Field===

Use the search box located at the top of the user field list to search for a user field.

|Status=No
}}{{Section
|sectionHeading=Create Multiple User Fields
|anchor=CreateMultipleUserFields
|alignment=Vertical
|structuredtext=

If you want to create more than one new user field, go to the User Fields page and click New Multiple.

Next, in the Field count box, enter the number of new fields you want to create. If, for example, you have 20 existing user fields and you want to add 12 new user fields, type 12 in this box. When you're finished, the system will add 12 new fields in sequential order (Other21-Other32).

You will then select each new field individually to define its {{Link-SomewhereInThisManual|topic=FieldLabels|anchor=labelproperties|display text=label properties}}.

|Status=No
}}{{Section
|sectionHeading=Edit User Fields
|anchor=EditUserFields
|alignment=Vertical
|structuredtext=

To edit the {{Link-SomewhereInThisManual|topic=FieldLabels|anchor=labelproperties|display text=label properties}} of a user field, go to the User Fields page and click the name of the field (in the Field Name column) or click the corresponding pencil icon to open and edit the field's properties.

{{NoteFormat|You cannot edit the Field Name for any user field.}}

|Status=No
}}{{Section
|sectionHeading=Delete User Fields
|anchor=DeleteUserFields
|alignment=Vertical
|structuredtext=

To delete a user field, click the trash can icon that corresponds to that user field or click the check box to the left of the field name and click the trash can icon at the top of the list of user fields.

{{NoteFormat|The following rules apply:
*Because the user fields in a contact list are ordered sequentially, you can only delete the last user field in a sequence. For example, if you have 27 user fields in your schema (Other1-Other27) and you want to delete Other25, you must first delete Other27 and then Other26.
*Because Other1-Other20 fields are standard fields in a contact list, those fields cannot be deleted. You can only edit the label properties for those fields.}}

|Status=No
}}{{Section
|sectionHeading=Apply a Labeling Schema to a Contact List
|anchor=ApplytoList
|alignment=Vertical
|structuredtext={{NoteFormat|A contact list can have only one labeling schema, but a labeling schema can belong to multiple contact lists.}}

After you've created the labeling schema, you can apply it to any contact list stored within CX Contact. Here's how it works:

#Create and save the labeling schema.
#{{Link-SomewhereInThisManual|topic=Lists|anchor=top|display text=Create or edit a contact list}} and choose the labeling schema from the '''Choose Label''' menu.

[[File:CXC_NewList_ChooseLabel.png|500px|center]]

Now, when you go to the '''Lists''' page, the name of the labeling schema that you applied to a contact list appears in the corresponding '''Labels''' column.
|Status=No
}}{{Section
|sectionHeading=Apply a Labeling Schema to a Dialing Profile, Campaign Template, or Campaign Group
|anchor=ApplytoCampaign
|alignment=Vertical
|structuredtext=Once you've created a labeling schema, you can apply it to a dialing profile, campaign template, or campaign group. Here's how:

#Create the labeling schema.
#Create or edit an existing dialing profile, campaign template, or campaign group.
#From the '''Labels''' menu, select the labeling schema.

The labeling schema will be applied to all contact lists that are part of the campaign group. The labels within the labeling schema will populate in the Contact Order menu as long as you selected the Display option when you defined the label properties for the user fields.

[[File:CXC_EditedLabels_ContactOrder.png|700px|center]]
|Status=No
}}{{Section
|sectionHeading=Apply a Labeling Schema to a List Rule
|anchor=ApplytoRule
|alignment=Vertical
|structuredtext=Once you've created a labeling schema, you can apply it to a either a selection rule or an upload rule, as follows.

===Selection Rule===

To apply a labeling schema to a {{Link-SomewhereInThisManual|topic=ListRules|anchor=SelectionRules|display text=selection rule}}.

#Create and save the labeling schema.
#Create or edit an existing selection rule.
#Select the labeling schema from the '''Labels''' menu.

The user fields contained in your labeling scheme will now populate in the '''Fields''' menu as long as you selected the '''Display''' option when you defined the label properties for the user fields.

[[File: CXC_EditedLabels_SelectionRule.png|800px|center]]

===Upload Rule===

If you are using the '''Split by Field''' option when applying an {{Link-SomewhereInThisManual|topic=ListRules|anchor=UploadRules|display text=upload rule}} to a contact list, you can apply a labeling schema. Here's how:

#Create and save the labeling schema.
#Create or edit an existing upload rule.
#Check the '''Use Splitting''' option.
#Select '''Field''' from the Split by field menu.
#Choose the labeling schema from the '''Labels''' menu.

The user fields contained in your labeling scheme will now populate in the '''Fields''' menu as long as you selected the '''Display''' option when you defined the label properties for the user fields.

[[File: CXC_EditedLabels_UploadRule.png|800px|center]]

===Filtering Rule===
To apply a labeling schema to a filtering rule:

#Create and save the labeling schema.
#Create or edit an existing {{Link-SomewhereInThisManual|topic=ListRules|anchor=FilteringRules|display text=filtering rule}}.
#Select the labeling schema from the '''Labels''' menu.

If you use the '''Use ordering''' option, the user fields contained in your labeling scheme will now populate in the '''Fields''' menu as long as you selected the '''Display''' option when you defined the label properties for the user fields. You can then define how you want to order and display the records within these fields in a contact list (options are Ascending and Descending). Refer to the {{Link-SomewhereInThisManual|topic=ListRules|anchor=FilteringRules|display text=Filtering Rules}} section of the {{Link-SomewhereInThisManual|topic=ListRules|anchor=top|display text=Create and Manage List Rules}} page for more information.
|Status=No
}}{{Section
|sectionHeading=Related Topics
|anchor=RelatedTopics
|alignment=Vertical
|structuredtext=*{{Link-SomewhereInThisManual|topic=AboutLists|anchor=top|display text=List Formats, Fields, and Database Tables}}
*{{Link-SomewhereInThisManual|topic=FieldLabels|anchor=top|display text=Create User-defined Field Labels}}
*{{Link-SomewhereInThisManual|topic=ListsSpecFiles|anchor=top|display text=Import Specification Files}}
*{{Link-SomewhereInThisManual|topic=DataMapping|anchor=top|display text=Create a Data Mapping Schema}}
|Status=No
}}
}}

@@ Line 5: / Line 5: @@
 |Context=Learn how to change the default label for a user field.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Role=Administrator
 |Application=CX Contact

PEC-OU/Current/CXContact/FieldLabels - Revision history

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Bgrenon: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"