Set up and configure the Backstage connector

All BA Insight connectors can be downloaded from the Upland Right Answers Portal under Knowledge > BA Insight > Product Downloads > Connectors. This connector is installed with the same generic steps as any BA Insight connector. You must satisfy the Prerequisites for your connector before installing. The configuration specifics are detailed below.

Create and configure connection

Use the following steps to add a connection Connection defines the how Connectivity Hub connects to your Source System (which contains your documents, graphics, etc.,). Your Connection includes identifying elements such as: URL of the BA Insight web service connector you are using, (File Share connector, SharePoint Online connector, etc.), Authentication mode, User Accounts and Credentials, Database information (for database connectors) to Connectivity Hub:

  1. In Connectivity Hub, navigate to the Connections tab and select New Connection > Web Service Connection.

  2. On the Connect to web service window, enter the following:

    1. In the Web service URL field, enter the web service URL to the connector web service. The URL must be in the following format: http://<host>:<port number>/dataconnector.asmx

      • <host> is the FQDN, host name, or IP of the server where the connector is installed.

      • <port number> is the port number entered during the installation wizard process.

    2. In the Authentication mode field, select your desired authentication mode from the drop down menu:

      • Use Service Account: The account running the job service and the account running the Connectivity Hub admin site will be granted access.

      • Specify User Account: Enter the credentials of a user account that you want to be granted access.

  3. Click Connect. The page re-loads with additional options.

  4. On the Connection Info tab, complete the following fields:
    1. In the Title field, enter a title to use for the connection.

  5. Click the General Settings tab and complete the following information to connect to the Backstage connector:

    1. In the Backstage backend url field, enter the url of your Backstage backend. This is the url that is used to make all API calls. For example, http://example.com:7007. By default, the port for this url is 7007.

    2. In the Backstage instance url field, enter the url of your Backstage frontend instance. For example, http://example.com:3000. By default, the port for this url is 3000.

    3. In the API token field, enter the static API token configured in Backstage that is used to make API calls and receive data. If no API token is provided, the connector assumes calls can be made as guest using api/auth/guest/refresh to fetch a temporary token.

  6. After creating your connection, you must create a content source Content Sources do the following: Receive data from the Source System via the Connection, Filter the data it receives, Provide the results to the Target, Define the specific search index that contains the content you wish to index (and later search). to pull the data from your source system Your Source System is the repository where your data is stored (data to be indexed). This repository is managed by applications such as: - SharePoint O365 - SharePoint 2013/16/19 - Documentum - File Share - OpenText - Lotus Notes - etc. Your Source System repository can also be a database such as SQL or Oracle. into Connectivity Hub. For more information, see How to Set Up Your Content Source for Indexing in the Connectivity Hub documentation.

Create and generate your metadata

To create Backstage content and generate metadata Provides context with details such as the source, type, owner, and relationships to other data sets. Metadata provides details around the item being crawled by Connectivity Hub., use the following steps:

  1. Navigate to Tasks > New Task.

  2. In the Scope field, select the Backstage connection that you created in the previous steps.

  3. In the Job field, select DataStore Load Collects the logical division of your data (data stores) from the source system. Runs on a schedule Logs information according to log level set. This Task retrieves a list of all TechDocs sites.

  4. Click Create.

  5. Return to the Tasks page and click New Task.

  6. In the Job field, select DataStore Types Load job Collects the types of data from your source system. Runs on a set schedule. Requires a log level which logs information. This task will fetch all types available for crawling. The connector only crawls items of type Component.

  7. Click Create.

  8. Navigate to the Content Source page and click the Content Source associated with your > > Metadata > Generate and generate metadata for the newly created Alfresco Content.

Connection Security Specifics

  1. Navigate to Tasks > New Task for your Backstage connection.

  2. In the Scope field, select the Backstage connection that you created in the previous steps.

  3. In the Job field, select Security Sync Loads User and Group tables and executes the mapping based on the connector configuration..

  4. Run the Security Sync job Loads User and Group tables and executes the mapping based on the connector configuration..