Search Roles

This page discusses:

See Also
Appendix - Deployment Roles and Related Processes
Appendix - CloudView Console Commands
Appendix - CloudView Support Information

Search Server

A process that can host Search API and UI services. For high availability and scalability, you can deploy as many Search Servers as required.

Attributes

UI name

XML Name

Type

Default

Required

Description

Instance name

instance

String

None

Yes

Name of this search server instance

API port

apiPort

Integer (TCP Port)

basePort+10

Yes

TCP port for APIs hosted on this Search Server

UI port

uiPort

Integer (TCP Port)

basePort+0

Yes

TCP port for UIs hosted on this Search Server

HTTPS

uiSSL

Boolean

false

No

Uses SSL for the hosted Mashup UIs

SSL Certificate

uiSSLCertificate

String

None

No

Name of the SSL certificate to use for the Mashup UIs. Use the name listed in the keystore.

Search API

An instance of the Exalead CloudView Search API. You can define multiple Search API configurations. A Search API role defines one instance with one configuration.

Attributes

XML Name

XML Name

Type

Default

Required

Description

Search server instance

searchServerInstance

String

None

Yes

Deploys this API to the specified Search Server

Search API config

apiConfig

String

None

Yes

Name of the SearchAPI config to deploy

Mashup API

An instance of the Exalead CloudView Mashup API for a single Mashup application.

Attributes

UI name

XML Name

Type

Default

Required

Description

Search server instance

searchServerInstance

String

None

Yes

Deploys this API to the specified Search Server

Instance name

instance

String

None

Yes

Name of this MashupAPI instance, referenced by MashupUI instances

Mashup application

applicationId

String

None

Yes

Name of the Mashup application for this Mashup API

Storage Service

Backend storage for Mashup UI. When using a collaborative widget, you actually enrich your document with data corresponding to the user's inputs. You can store this data using the storage service.

For more information, see Configuring Data Storage for Collaborative Widgets in the Exalead CloudView Mashup Builder User's Guide.

Attributes

UI name

XML Name

Type

Default

Required

Description

Instance name

instance

String

None

Yes

Name of this Storage Service instance referenced by MashupUI instances

Search server instance

searchServerInstance

String

None

Yes

Deploys this Storage Service to the specified Search Server

Mashup UI

An instance of the Exalead CloudView Mashup UI for a single Mashup application.

Attributes

UI name

XML Name

Type

Default

Required

Description

Search server instance

searchServerInstance

String

None

Yes

Deploys this UI to the specified Search Server

Instance name

instance

String

None

Yes

Name of this Mashup UI instance

HTTP context path

context

String

None

Yes

HTTP context path where the Mashup application is deployed; by default, /mashup-ui

Storage service instance

storageservice

String

None

Yes

Instance name of the Storage Service role

Mashup application

applicationId

String

None

Yes

Name of the Mashup application for this Mashup UI. Value: default

Mashup WAR path

mashupWarPath

String

None

No

Path to the Mashup WAR file

Mashup description

mashupWarPath

String

None

No

Description for the Mashup application

For SSL configuration, see Enable HTTPs for the Mashup UI.