Follow this procedure to learn how to publish to a background queue.


On this page



Step 1. Launch Aspire and Open the Content Source Management Page

Launch Aspire (if it's not already running). See:

Step 2. Add a New Content Source

  • For this step please follow the step from the Configuration Tutorial of the connector of you choice, please refer to Connector list

Step 3. Add a New Publish to Background Queue to the Workflow

To add a Publish to Background Queue, drag from the Publish to Background Queue rule from the Workflow Library and drop to the Workflow Tree where you want to add it. This will automatically open the Publish to Background Queue window for the configuration of the publisher.

If the publisher is not shown, you can add a custom publisher with the co-ordinates com.accenture.aspire:aspire-bg-queue-publisher-source

Step 3a. Specify Publisher Information

 In the publisher configuration window, specify the following:

  1. Name: Enter the name of the publisher. (This name must be unique).
  2. Queue: The information about the queue to publish to
    1. Database: The name of the noSQL  database holding the queue
    2. Name: The queue name within the database

    HINT: The queue database will be prefixed with the cluster id to make it unique if more than one Aspire cluster shares the same NoSQL provider. It is currently not possible to publish to a queue accessed by another Aspire cluster
               The user is responsible for ensuring that the location typed in that box is the correct one of the file being used.

  3. Unique queue id: If checked, each item published to the queue will be give a unique document id
    1. Document ID field: When a unique queue id is not used, you can configure the path to the document field that should be used as the document id
  4. Publish only Adds/Updates: If checked, documents with an action of “delete” will not be published to the queue
  5. Clear the queue on full crawl: If checked, any queue items will be removed when a full crawl is started. NOTE: when this option is selected, it requires the connector used to emit start jobs
  6. Use transform:
    1. When not selected, the entire Aspire document for a job will be added to the queue
    2. If selected, a file containing and XSL transform can be used to select the metadata to write to the queue
      • XSLT Transform: The name of the XSL file holding the transform to use when publishing data to the queue. Several pre-built transforms are available
        • all.xsl: copies everything – equivalent to using no transformation
        • id.xsl: copies the identifier and source id
        • url.xsl: copies the identifier source id, url, fetchUrl and displayUrl
        • content.xsl: copies the identifier source id, url, fetchUrl, displayUrl and content
  7. Debug: Check if you want to run the publisher in debug mode.
  8. Click on the Add button.

Once you've clicked Add, it will take a moment for Aspire to download all of the necessary components (the .jar files) from the Maven repository and load them into Aspire. Once that's done, the publisher will appear in the Workflow Tree.

For details on using the Workflow section, please refer to the Workflow introduction.