Installation Process

Install the Content API Listener Server service

Content source management page

Login to Aspire or use the home button to return to the home page. You should now see something similar to this (your system may include some connectors):

Settings menu

Using the settings button on the right hand side of the screen to load the Services console.

Services management page

This will take you to the following screen:

Select FAST Content API

Select Add service and then FAST Content API

Service configuration

The service will now load the configuration screen. This may take a moment if the connection to the internet is slow. Once the service has been downloaded, you will see the following:

Service configuration

Enter a service name:

Service configuration

Click the Service tab at the top of the screen or use the arrow at the right of the screen to move to the service configuration screen. You will now see the service configuration. Enter values for the name and connector or leave the default values.

• Content Tag
  • If specified, a tag with the given name will be created in the root of the AspireObject that will be published and all data sent by the FAST client will be added under that tag. If not specified, all data passed will be added to the root of the AspireObject created.
• Convert ByteArrays
  • If checked, any ByteArrays sent by the FAST client will be converted to Strings before being added to the AspireObject
• Use external call backs
  • By default, the FAST Content API Listener provides callbacks to the FAST client based on the status of the job in Aspire. That is, if the job is seen as complete in Aspire, a callback will be given. Check this box if you want something else (such as the Fast publisher) to be responsible for the call backs. You'll then be prompted to point to the component that will provide the callbacks.
  • Component
    • The component that will provide the callbacks
• Job termination callback
  • If a job if terminated in the processing pipelines, what call back should be reported to the client
• Sub-systems
  • Leave blank to return the default subsystems to the FAST client or configure your own to be reported back
  • Name
    • The name of the sub system - normally processing or indexing
  • ID
    • How the sub-system should be reported to the client. e.g. indexing:1:1 or processing:0:1
  • Success callbacks
    • The list of callbacks that should be reported to the client upon successful processing. e.g. secured,completed
  • Error callbacks
    • The list of callbacks that should be reported to the client upon failed processing. e.g. secured,completed
• Workflow reload period
  • The period after which to reload the business rules. Defaults to ms, but can be suffixed with ms, s, m, h or d to indicate the required units
• Error tolerant
  • When set, exceptions in workflow rules will only effect the execution of the rule in which the exception occurs. Subsequent rules will be executed and the job will complete the workflow successfully. If not set, exceptions in workflow rules will be re-thrown and the job will be moved to the error workflow

Turn on debug if required.

Services management page

Once the values are configured, press Save at the top of the screen to save the configuration and load the service. Again this may take a moment while the required components are downloaded. Once the service is installed, you will be taken back to the services home page.

The configuration of the FAST Content API Listener service is now complete.