This is a working sample of a custom ODS External Search Provider.
This is commonly used to search third-party systems for people/organisations; for example a PMS or CRM.
| File | Purpose |
|---|---|
ExampleOdsSearchProvider.cs |
This is the provider implementation. It is responsible for calling the third-party system and collating the results |
ExampleOdsSearchProviderConfig.cs |
This is the model representing any custom configuration needed for the provider |
./_Content/OdsExternalSearchProvider/* |
These files contain an example of a custom configuration UI for the provider |
The provider will appear in 'Global Features' under the 'ODS External Search' feature.
-
Open the feature, click the
+button, and select the 'Example Provider'.It will be added to the list of providers:
-
Clicking the cogs icon will open the custom configuration panel.
Enter some text into this box, Save & Close twice, and recycle the Modeller configuration.
-
Create a new ODS Organisation (
/admin/organisationList-> "Add New")The provider appears in the 'Create from..' menu. Select it:
-
Enter any search string and press Enter.
The provider will return a single result (
Organisation 1), prefixed with the text we entered in our custom configuration (step 2).