Entity Selection Criteria view

Entity Selection Criteria (ESC) define search criteria for use by Job Definitions in the Job Server. Transportation Smartbench (TSB) allows you to define an ESC using either SQL or the findEntities API format. Once defined, an ESC can be referenced by Job Definitions, for use by the Job Server when running an instance of that Job Definition. Not all job types require ESCs, and some job types require specific ESC formats. See Job Types for more information about the ESC requirements of each job type.

An ESC differs from a TSB search in the following ways:

ESCs are utilized by the Job Server when processing job instances. Although ESCs are defined in TSB, TSB does not utilize ESCs.
ESCs can be defined for all TM entity types. TSB searches can be defined only for Transportation Smartbench supported entities.
ESCs can be stored in either SQL or findEntities API format. SQL ESCs can perform selection criteria that would not be possible using a findEntities API. findEntities API ESCs can retrieve any data for any entity which the findEntities API supports.
When ESCs are processed by the Job Server, the information retrieved by either SQL or findEntities API is utilized by the job instance being run and may be handled differently depending upon the job type. For more information about how a specific job type utilizes ESCs, see the documentation for that job type.
ESCs support custom SQL/XML so that search criteria can be crafted for entities which TSB does not yet support.

The ESC will store properties of the criteria, including optionally indicating the maximum number of entities that should be allowed to be returned. If the maximum number of entities is exceeded when the selection criteria is run by a job instance, the job instance will not process any of the entities returned.

TSB supports creating an ESC based on an existing TSB search. When an existing TSB search is selected as the basis for an ESC, TSB will provide the equivalent SQL or findEntities API content for that search. Once retrieved, the SQL of findEntities API content may be modified as required.

An ESC can also be created by specifying the SQL or findEntities API content directly. This is supported for any TM entity, including entities for which TSB does not support searches.

When a SQL based ESC is edited, the system validates the SQL statement to ensure that it does not access tables or information that are confidential. Additionally, the SQL is restricted from performing any updates, inserts, or deletes.

Note: For job types that utilize ESCs to identify the entities to be processed, SQL ESCs should only return the entity identifier or identifiers. The SQL should not return any other information in the Select clause. For job types that utilize ESCs in different ways, refer to the documentation for that Job Type to determine what data may be returned and how the data will be processed.

In this section