System Objects

All system objects are indexed, except for Accounts, Admin Settings, Expense, Group and User. Following is the list of all System Fields which are indexed. The table shows which fields are indexed and searchable. Note: there are system fields that are automatically added to new custom objects when they are created. That list of system fields is represented under the generic custom object example, "Project", in the table. If you need to be able to search for a field that is not currently searchable, please submit a support ticket.

Jump Past Table

Many system fields are indexed but not all are searchable. These fields can be used as filters. For more information, visit Using Filters with Global Search.

Custom Object

Any Custom Object can be indexed. Administrators control that and it is defined in Setup. 

Object and Field Mapping

Object mapping is the process of translating the TeamConnect object and the fields picked for indexing into a json object that will represent the structure of the object and its fields in Elasticsearch. When objects and fields are mapped to the index, they become searchable.

NOTE: Some field types take up more than 1 space in the index.

Field Types map as follows:

How do I know how many fields I have for each object?

To calculate the space each object will take, query the database for the number of fields by field type for a given object. An example of how to calculate whether your index will hit the limit looks like the following:

*Multiplier varies based on the number of values in the multi-value list.

In this scenario, you have 344 fields on an object but they take up 917 spaces in the index. Your object will still index so, in this case, it is safe to proceed.

NEW! However, in TeamConnect 6.3.3, there is a new column in the Global Search Index Tool, called Field Count, that shows how many spaces are taken by the fields on an Object and how many spaces are available. Example:

Also note, the field limit is 5000 instead of 1000. In TeamConnect 6.3.3, administrators can adjust the field limit count between 1000-5000 to accommodate for more custom and system fields on each object. If the index fails because the number of fields exceeds the field count limit, an error will appear in the Global Search Index Tool telling the Admin which field(s) need a higher limit. Visit the Global Search Index Tool page for more details.

Extending a System Object with Custom Fields

When adding custom fields onto a system object, some objects are immediately ready to for searched (for example, Tasks and Contacts). Other objects require a manual re-index (ex: Appointments). For example:

• Creating a task, the task is indexed, and then a custom field is added: all existing tasks are updated with the custom field and can be searched on immediately after the refresh interval, no manual re-index is necessary.
• Adding a custom field to tasks, then creating a new task: all existing tasks are updated with the custom field, and the newly created task is indexed with the new custom field. All tasks and their custom fields can be searched on without re-indexing.
• Creating an appointment, the appointment is indexed, and then a custom field is added: all appointments require a full re-index for the custom field to be searched on. Any new appointments created after the custom field is created cannot be searched on.
• Adding a custom field to appointments, then creating a new appointment: all existing appointments must be re-indexed to search on the custom field, but can be searched on with their pre-existing searchable fields.

One index per object

In TeamConnect 6.0 and earlier versions, all TeamConnect was stored in one index in Elasticsearch. To improve performance, facilitate upgrades, and allow users to search during re-indexing, TeamConnect 6.1 indices now have homogeneous types (object entityTypes) and one index per object, along with a STATUS index. 

In TeamConnect 6.0 and earlier versions, the "ElasticSearchUUID" system setting is stored in the database and the UUID value is the name of the index. The new TeamConnect 6.1 naming convention for the indices is in the format UUID-[uniqueCode for object]. For example, index name for Contacts will be <UUID>-cont. For this reason, existing clients must delete their index in the previous version of TeamConnect before upgrading, then rebuild the index after the upgrade. Existing clients with Search Guard must do the following when upgrading:

• Since these configurations added the index name (the UUID from the database) added to their certificate on the node, update the certificate to include a wildcard after the UUID name.
• In the SG_ROLES.YML file, the index names under each role refer to the ElasticsearchUUID from the database. At the end of each index name, add an asterisk at the end of the name, before the closing single quote.

For example, In TeamConnect 6.0 and earlier versions:

In TeamConnect 6.1:

API Indexers

To improve the speed of indexing, starting in TeamConnect 6.1 now uses 2.x objects rather than 3.x objects on all of the indexers for serialization. With 3.x objects, the LegacyBuilder classes loaded parts of the objects that are not needed for the indexer classes, resulting in excessive database access. Additionally, using 2.x objects eliminates the need for the recurring thread to convert the objects from 3.x.