Create a Segment Entity

In order for an entity to be available to Segment Mechanism, it has to meet the following conditions:

1. Entities Metadata File

In entities metadata file <segmentincluded> tag's value must be set to true. Keep in mind that <segmentincluded> default value is false.

2. Fields Metadata File

In fields metadata file:

1.  <qlfieldname> tag's value is the CRMQL field name and must be defined for the fields that you want to be available as segment criteria.
2. <segmentpreviewname> tag's value must be defined for the fields that you want  to be displayed when previewing a segment. Valid values are ENTITYNUMBER, ENTITYNAME, ENTITYALTCODE, ENTITYDESC and are used when you want the field to be displayed as the entity's number, name, alternative code or description accordingly.