Content Source Manager

This is the landing page for the Admin User Interface (UI). This page displays the content source "cards" that show current status, start time, running time, jobs completed, errors and more.

  • You can create, sort, search, filter, group, view, and control the content sources.
  • You can even change each content source card's position by dragging the content source and dropping it over the content source you want to swap places with.

 

Top Bar Manager

Most of the functionality for the Manager section can be found in the top bar.

Functionalities

  1. Aspire Logo
    • Normally is a link to the Home page, depending of the section. For Manager, it does nothing.
  2. Current User
    • Indicates the current user logged in.
  3. Server Connection
    • Indicates the speed of the connection between the browser and the server.
      • GREEN: Less or equal to two seconds (>= 2s)
      • YELLOW: From two to 4 seconds (< 2s and >= 4s)
      • ORANGE: Higher than 4 seconds (< 5s)
      • RED: No response from the server
  4. Aspire Wiki
    • Opens a new tab to the wiki.
  5. Debug Console
    • Access Aspire Debug in a new tab.
  6. Refresh
    • Reloads just the content sources, without reloading the whole page.
  7. Group
    • Enables the grouping option for all the content sources.
  8. Import
    • Imports a .zip file with the configuration for a content source.
  9. Add Source
    • Opens the menu with all the available connectors to create a content source.
  10. Search
    • Filters the content sources based on the search string (can be a plain text or a regex expression).
  11. Filter
    • Opens the menu to all the filters available.
  12. Directory
    • Access other sections of Aspire (Service, OS License, Developer tools, Servers and About.)

 


 

Content Source Configuration

Admin UI provides a wizard style configuration process to create a complete content source, divided in three main sections (General, Connector and Workflow).

GeneralGeneral

ConnectorConnector

workflowWorkflow

Top Bar Configuration

On the top bar, we find the general functionality as well as helpful information from the content source.

Functionalities

  1. Aspire Logo
    • A link to the Home page (Content Source Manager).
  2. Current Content Source
    • Displays the icon of the connector type and the name of the content source.
  3. Current User
    • Indicates the current user logged in.
  4. Server Connection
    • Indicates the speed of the connection between the browser and the server
      • GREEN: Less or equal to two seconds (>= 2s)
      • YELLOW: From two to 4 seconds (< 2s and >= 4s)
      • ORANGE: Higher than 4 seconds (< 5s)
      • RED: No response from the server
  5. Home
    • A link to the Home page (Content Source Manager).
  6. Aspire Wiki
    • Opens a new tab to the wiki.
  7. Debug Console
    • Access Aspire Debug in a new tab.
  8. Return
    • Checks the configuration for changes. If none, returns to the Home page. You have the option to discard the changes.
  9. Done
    • Checks the configuration for changes. If none, returns to the Home page, You have the option to discard the changes.
  10. Save
    • Save or Updates the content source.
  11. Directory
    • Access other sections of Aspire (Service, OS License, Developer tools, Servers, and About).
  • Saving the content source will not redirect to the Home page.
  • Clicking Save will not save the workflow. The workflow saves automatically with each change.

General Configuration

The General Configuration contains the basic information for the content source. Every content source has the same General Configuration layout.

 

  1. Step Indicators
    • Each step of the configuration is displayed here. You can click and move to any step directly.
  2. Name
    • The display name of the content source.
  3. Enable
    1. Select the check box to indicate if the content source must be enabled. Clear the check box if it should be disabled.
  4. Schedulers
    • Create a scheduler for various crawls and actions at different time intervals.
    • Add more schedulers by clicking Add New.
      1. Scheduled: A list with all the time options for the scheduler.
        1. Manually: No additional options.
        2. Periodically: Specify the "Run every" option by entering the number of "hours" and "minutes."
        3. Daily: Specify the "Start time" by clicking on the hours and minutes drop-down lists and selecting options.
        4. Weekly: Specify the "Start time" by clicking on the hours and minutes drop-down lists and selecting options, then selecting the day check boxes to specify days of the week to run the crawl.
        5. Advanced: Enter a custom CRON Expression (e.g. 0 0 0 ? * *)
      2. Action: A list of the possible actions to be performed by the current scheduler (Start, StopPause, or Resume).
      3. Crawl: A list of the types of crawl to be executed by the current scheduler (Incremental, FullReal Time, or Cache Groups).
  5. System Name
    • The name of the content source for the server, created from the display name provided. It is only available after the content source is saved.
  6. Next Step
    1. Clickable area to move to the next step.
  • Crawl options can vary between content sources depending of the connector used. Action options are available depending of the Crawl type selected.
  • The System Name can not be changed. It is only available after the content source is saved
  • The Name of the content source can't use the following characters (\ / * ? " : > < |), and the length can't be longer than 50 characters
  • You can change between Scheduled types and maintain the same time relationship. Go to Advanced to see the CRON expression.
  1. Advanced Configuration
    • Advanced Configuration is always disabled by default and it will used the default configuration. To change the configuration, select the check box.
  2. Test Connection
    • Test the connection with the current configuration. The test connection will be always at the end of the configuration, if available.

 

  • The content source must be created before doing a Test connection. If the content source is still not created, save it first.

Workflow Configuration

The workflow configuration is where the customization of the data is done. You can edit, delete, add, and publish information using our apps, scripts, or even add your own custom apps

  1. Scanner
    • This section represents the scanner component inside the connector, which retrieves the information.
  2. After Scan
    • Step between the Scanner and the Fetch Content. You can add your own rules and apps inside this step.
  3. Fetch Content
    • This section represents the fetch content component that retrieves the document information. 
  4. On Add Update
    • Step containing documents that were added of updated. You can add your own rules and apps inside this step.
  5. On Delete
    • Step containing document that were deleted. You can add your own rules and apps inside this step.
  6. On Publish
    • Step containing documents regardless if they were added, deleted, or updated. You can add your own rules and apps in this step.
  7. On Error
    • Step containing all errors thrown during the workflow process.
  8. Previous Step
    • Clicking areas; to move to the previous step
  • For more information about the Workflow, see the Workflow page.

Content Source Error

Admin UI presents a friendlier way to display error logs, and more control to move around the pages.

Top Bar Error

On the top bar, we can find general functionality as well as controls to visualize different errors.

Functionalities

  1. Aspire Logo
    • A link to the Home page (Content Source Manager).
  2. Current Content Source
    • Displays the icon of the connector type and the name of the content source.
  3. Current User
    • Indicates the current user logged in.
  4. Server Connection
    • Indicates the speed of the connection between the browser and the server
      • GREEN: Less or equal to two seconds (>= 2s)
      • YELLOW: From two to 4 seconds (< 2s and >= 4s)
      • ORANGE: Higher than 4 seconds (< 5s)
      • RED: No response from the server
  5. Home
    • A link to the Home page (Content Source Manager).
  6. Aspire Wiki
    • Opens a new tab to the wiki.
  7. Debug Console
    • Access Aspire Debug in a new tab
  8. Refresh
    • Refreshes the page in case the content source has updated the error log.
  9. Error Categories
    • Each category displays different errors with different causes.
      • Document
        • Issues that are normal involving corrupted documents, security protected, missing links, and others. This type of errors normally does not interrupt the crawl process.
      • Scanner
        • Errors involving configuration that prevents the scanner from performing a crawl.
      • Batch
        • Problems with the batches normally thrown during the workflow process.
      • Failed
        • Errors that prevent the content source from initializing the scanner.
  10. Page Size
    • Controls the page size in the sizes of 25, 50, 75, and 100 documents per page.
  11. Clear File
    • Deletes the current error document (Category).
  12. Directory
    • Access other sections of Aspire (Service, OS License, Developer tools, Servers and About.)

Simplified Display

Admin UI simplifies the error display by hiding the information and just displaying the error identifier.

  1. Error
    • This whole section represents an error in the log document.
  2. Sequence ID and Date
    • Every error has a sequence ID that may change if the content source updates the log file, including a date of when the error was added.
  3. Paging
    • Paging allows you to move more quickly between pages and move from the oldest error to the newest with just one click.

 

  1. Expand Error
    • To expand an error and see more detailed information, just click on the plus sign, right next to the sequence ID
  • No labels