Perform Advanced Operations with the API Console

The API Console exposes administration, inspection, and operations for all the management objects. These objects give complete control over the product's configuration parameters, as well as status information for the platform's components.

The API Console provides access to Exalead CloudView APIs (known as MAMI), allowing you to:

• Edit most configuration files and apply changes. The exceptions are the configurations for Mashup Builder, Business Console (as well as Content Recommender component of the Business Console, if installed).

• Push simple documents to test your searches.

• Perform XML searches.

• Perform all operation and inspection commands on Exalead CloudView.

The API Console is available at:

http://<HOSTNAME>:<BASEPORT+1>/api-ui

Select an API Console menu, that is Manage, Push, or Access.

In the event of an error, for example, REQUEST TO SERVER FAILED!, the API Console provides a log for complete details.

If an error occurs, press SHIFT + H. To pause the log, press SHIFT + Z.

The API Console gives you access to configuration and monitoring for all Exalead CloudView Management objects via the Manage menu. Each service has procedures allowing you to:

• Configure

• Operate

• Inspect

This service	Manages Exalead CloudView's...
adminui	Administration Console
alerting	Real-time alerting
connect	Data source connectors (except HTML)
consolidation	Consolidation Server process
convert	Document conversion process
crawl	HTML connector
datamodel	Data model classes and properties
deploy	Server deployment
fetch	HTTP fetchers
indexing	Index build process.
linguistic	Linguistic configuration
master	Deployment, including applying changes, job scheduling, and security
resource manager	Resources configuration
search	Search API
thumbnails	Thumbnails generator

Once the platform is configured, and the index is built, you can access the search engine via the Access menu. You can view the search results either in XML or in Text format.

To test the search engine and get the results as text:

1. Click text to access this search engine.
2. Enter the search terms in the query box.
3. From the lists, select the search application and the search page you require.
4. Add security tokens to the search if required.
5. Click Search.

   This displays your search results in text format.

To test the search engine and get the results as XML:

1. Click xml to access this search engine.
2. Enter the search terms in the query box.
3. From the lists, select the search application and the search page you require.
4. Add security tokens to the search if required.
5. Click Search.

   This displays a structured and color-coded view for the results of your query. The syntax highlight displays for markup languages only.