Overview of CustomSearchJoin and CustomSearchRowBasic
This topic describes some of the basics of using CustomSearchJoin and CustomSearchRowBasic.
Executing a Search
To use CustomSearchJoin, you can execute either a joined search or an advanced search.
For example, consider an employee record that has been altered to include a custom field pointing to the account record. In this case, you can search the employee record and use CustomSearchJoin to include data from the account record as part of your search criteria. You would execute your search using either of the following two objects:
-
EmployeeSearch — Results returned would include the entire employee record for each employee that meets your criteria. (For general details on this type of search, see Joined Searches in SOAP Web Services.)
-
EmployeeSearchAdvanced — Results returned could include any columns you specify from the employee record or the account record. (For general details on this type of search, see Advanced Searches in SOAP Web Services.) In this scenario, you would use CustomSearchRowBasic as well as CustomSearchJoin.
Sample Use Cases for CustomSearchJoin
You can use CustomSearchJoin in a couple of different scenarios.
A common case is one in which you have altered a standard record type to include a custom field that references another standard record type. This scenario includes the example where your employee record has been altered to include a custom field that points to the account record.
Additionally, you can join to and from custom record types. For example, suppose your organization uses custom record types called Customer Survey and Customer Suggestion. If Customer Survey and Customer Suggestion both include fields that reference each other, a search of Customer Survey could include a join to Customer Suggestion and vice versa.
Similarly, you can join between the following:
-
A customized record type that references a standard record type.
-
A standard record type that references a custom record type.
Sample Use Cases for CustomSearchRowBasic
CustomSearchRowBasic can be used in conjunction with all of the custom field usage described above for CustomSearchJoin.
Additionally, your search does not have to include the use of CustomSearchJoin in order for you to use CustomSearchRowBasic. For example, you could use EmployeeSearchAdvanced to search using criteria that is defined on the employee record (and not use any joins). But in your results, you might still want to include data from the record referenced by a custom field on the employee record. You do this using CustomSearchRowBasic.
Note that CustomSearchRowBasic is available only when you are executing an advanced search.
CustomSearchJoin and CustomSearchRowBasic are available only for accounts that have upgraded to 2013.2 or a later endpoint.