SearchEngine.save (Method)

Creates or updates a search engine definition.

Returns:

SearchEngineID (integer)

Arguments:

Name Type Required Description
searchEngineID SearchEngineID_0 Required Unique ID of this search engine, or 0 to create a new one.
name PlainText_100 Required Name for this search engine.
urlMatchString PlainText_255 Optional. Defaults to an empty string. String that a URL must match to be identified as belonging to this search engine.
searchStringFieldName PlainText_50 Optional. Defaults to an empty string. URL field that contains the search term the user entered.
userAgents StringArray Optional. Defaults to '#ArrayNew(1)#'. An array of zero or more user agent strings.

Context:

License Requirements (none)
Permission Requirements site:SiteAdmin
Deny Context (none)
Require Context AuthoringEnabled
Author Lock (not required)
Transaction Logging If transaction logging is enabled at the site level, calls to this method will be logged
Customization Customization is not supported for this method.

Error Codes:

Code Error Message
81500 For the current version, CommonSpot does not allow creation of search engines that track rankings.
81501 Another search engine with the same name already exists.
81508 Path of the interface component is required to enable search ranking tracking.
81509 Please provide the properties XML to enable search ranking tracking.
81516 Another search engine record with the same field name and URL match string already exists.

Notes:

None