Defining an External Push API Server

For deployment reasons, you may want to push document sources (that is, one or more connectors, a Replay Server or a Consolidation Server) on an external Push API server located on another Exalead CloudView instance.

This task shows you how to:

See Also
Controlling Connectors

Create a Custom Push API Server

  1. In the Administration Console, go to Deployment > Push API Servers.
  2. Click Add Push API server.
  3. Configure the external Push API Server you want to target with the following parameters.

    Parameter Description
    Name Name of the custom Push API Server in your source instance. For example, mypapi
    Hostname Hostname of the external target instance.
    Port Push API Server port of the target instance, for example, <BASEPORT>+2
    Use HTTPS

    Enables HTTPS for the communication between the Push API servers of your source and target instances.

    For more information, see Enable HTTPS for the Push API.
    Push API version As of now, only V4 is supported.
    Seen as ...

    Source name to display on the target instance. If not defined, the source connector (or Replay Server, or Consolidation Server) name is used by default.
    Login

    Login of the source that pushes documents to the target instance.
    Password

    Password of the source that pushes documents to the target instance.

  4. Click Apply.

Create a Source Linked to the External Instance

The second step consists in creating the source linked to the external Push API Server. that is to say a connector, a Replay Server or a Consolidation Server.

This procedure shows how to create a connector that pushes documents to the external Push API Server.

  1. Go to Index > Connectors.
  2. Click Add connector.
    1. In Name, enter the connector name, for example Filesystem1
    2. For Type, select a connector type, for example, files.
    3. For Push to PAPI server, select your custom external PAPI server, for example mypapisrv.
    4. Click Accept.
  3. Configure your connector.
  4. Click Apply.

Scan Your Source and Check the External Instance

  1. Go to the Home page.
  2. Under Connectors, click Scan for the source connector that must push documents to the external PAPI Server.



    Neither the Tasks nor the Documents columns display counts for pushed documents (they stay with 0~), and the Status remains idle.
  3. Open the Administration Console of your external Exalead CloudView instance, that is, use the hostname defined previously as follows: <HOSTNAME>:<BASEPORT>+1 (do not use the port of the external Push API server) .

The source connector displays on the Home page with the name specified in the Seen as... Parameter. The Documents column shows the count of documents pushed by the source instance.